The GetLicenseOrderTemplate function is used to get a complete license order object with pre-defined settings taken from a Product Template. Some fields in the license order can initially be empty if they are empty in the Product Template. The License Order contains all information about HostIDs and Features configured for the product in the Product Template.

This function requires a login token, which is obtained using the Login function. This function also uses the product template ID for which the license order template should be generated. After changing data and filling out all necessary fields, you can add the complete license order using the AddLicenseOrder method.

See ID fields for information about using the ID field.

Return values

The response is of the type Soap_Response_LicenseOrder with result_object of type Soap_LicenseOrder.

Example request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="https://license.x-formation.com/soap/type/vendor/version/1?wsdl">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetLicenseOrderTemplate soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <token xsi:type="xsd:string">bf1a02f2554e71b6867dae307956a2e4fa1abe1e</token>
         <productTemplateId xsi:type="xsd:int">1</productTemplateId>
      </ns:GetLicenseOrderTemplate>
   </soapenv:Body>
</soapenv:Envelope>

Example response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://license.x-formation.com/soap/type/vendor/version/1?wsdl"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:GetLicenseOrderTemplateResponse>
         <return xsi:type="ns1:Soap_Object_LicenseOrder">
            <result_object xsi:type="ns1:Soap_LicenseOrder">
               <customer_id xsi:type="xsd:int">0</customer_id>
               <product_template_id xsi:type="xsd:int">2</product_template_id>
               <activation_key xsi:nil="true"/>
               <creation_time xsi:nil="true"/>
               <license_type xsi:type="xsd:string">local</license_type>
               <licensee_type xsi:type="xsd:string">not_specified</licensee_type>
               <licensee xsi:nil="true"/>
               <hostid_match_rate xsi:type="xsd:int">100</hostid_match_rate>
               <min_hostids xsi:type="xsd:int">1</min_hostids>
               <activated_licenses_count xsi:nil="true"/>
               <enabled xsi:type="xsd:boolean">true</enabled>
               <description xsi:nil="true"/>
               <Hostids SOAP-ENC:arrayType="ns1:Soap_Hostid[1]" xsi:type="ns1:ArrayOfSoap_Hostid">
                  <item xsi:type="ns1:Soap_Hostid">
                     <name xsi:type="xsd:string">Not Locked</name>
                     <min_amount xsi:type="xsd:int">1</min_amount>
                     <max_amount xsi:type="xsd:int">1</max_amount>
                  </item>
               </Hostids>
               <Features SOAP-ENC:arrayType="ns1:Soap_Feature[1]" xsi:type="ns1:ArrayOfSoap_Feature">
                  <item xsi:type="ns1:Soap_Feature">
                     <name xsi:type="xsd:string">f1</name>
                     <version xsi:type="xsd:string">1</version>
                     <expiration_type xsi:type="xsd:string">no_expiration</expiration_type>
                     <expiration_date xsi:nil="true"/>
                     <additional_settings xsi:nil="true"/>
                     <enabled xsi:type="xsd:boolean">true</enabled>
                     <days_from_activation xsi:nil="true"/>
                     <count xsi:nil="true"/>
                  </item>
               </Features>
            </result_object>
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:GetLicenseOrderTemplateResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels