The GetLicenseOrderList function is used to get a license order list. The license order contains all information about HostIDs and Features configured for the product.

This function uses an offset and requires a login token, which is obtained using the Login function.

Return values

The response is of the type Soap_Response_List_LicenseOrder, with result_array of type ArrayOfSoap_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:GetLicenseOrderList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <token xsi:type="xsd:string">e84b130bcd3fdf26644064098acdf9f3e5a3bfaa</token>
         <offset xsi:type="xsd:int">0</offset>
      </ns:GetLicenseOrderList>
   </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:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body>
      <ns1:GetLicenseOrderListResponse>
         <return xsi:type="ns1:Soap_List_LicenseOrder">
            <result_array SOAP-ENC:arrayType="ns1:Soap_LicenseOrder[1]" xsi:type="ns1:ArrayOfSoap_LicenseOrder">
               <item xsi:type="ns1:Soap_LicenseOrder">
                  <customer_id xsi:type="xsd:int">2</customer_id>
                  <product_template_id xsi:type ="xsd:int">1</product_template_id>
                  <activation_key xsi:type="xsd:string">8YIVD-UGBMH-O77N6-4TPD6</activation_key>
                  <creation_time xsi:type="xsd:string">2011-09-08 12:59:35</creation_time>
                  <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:type="xsd:int">1</activated_licenses_count>
                  <enabled xsi:type="xsd:boolean">true</enabled>
                  <description xsi:type="xsd:string">desc</description>
                  <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[2]" 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>
                     <item xsi:type="ns1:Soap_Feature">
                        <name xsi:type="xsd:string">f2</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>
               </item>
            </result_array>
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:GetLicenseOrderListResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels