Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Function The GetLicenseOrderList function is used to get a license order list for a LAC administrator, using token and offset. The license order contains all information about Hostids and Features configured for the product.

This function requires a LAC administrator token, which is obtained using the Login function.

In addition, this function uses an offset. License orders are packed into arrays of 100 elements. You can use an offset greater than 0 to take additional license ordersget additional license orders. For example, if you have 321 license orders, you would run this method 4 times using the offsets 0, 100, 200, 300. The first 3 responses will have 100 license orders each, and the last response will have 21 license orders.

Return values

On failure, the result string contains an error message. See Return codes for further information on error messages.

Example request:

No Format
<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="http://www.lac2.pl:8080/soap/type/vendor/version/1">
   <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:

No Format
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://www.lac2.pl:8080/soap/type/vendor/version/1"
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>
                  <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>
  <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>