The FindLicenseOrderByActivationKey function is used to to find one or more license orders by activation key.
The activation key can be a partial entry (for example, to find a license order using activation key P14TT-QZ289-GJFQQ-1DQLY, you could enter only "QZ289") and is case-insensitive (for example, "QZ289" and "qz289" are interpreted as the same entries).
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
| 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="https://license.x-formation.com/soap/type/vendor/version/1?wsdl">
<soapenv:Header/>
<soapenv:Body>
<ns:FindLicenseOrderByActivationKey soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<token xsi:type="xsd:string">a8ddd1c51d7831c8babc98d816274b599aef852b</token>
<activationKey xsi:type="xsd:string">QZ289</activationKey>
<offset xsi:type="xsd:int">0</offset>
</ns:FindLicenseOrderByActivationKey>
</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="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:FindLicenseOrderByActivationKeyResponse>
<return xsi:type="ns1:Soap_Response_List_LicenseOrder">
<result_array SOAP-ENC:arrayType="ns1:Soap_LicenseOrder[2]" xsi:type="ns1:ArrayOfSoap_LicenseOrder">
<item xsi:type="ns1:Soap_LicenseOrder">
<customer_id xsi:type="xsd:int">9</customer_id>
<product_template_id xsi:type="xsd:int">1</product_template_id>
<activation_key xsi:type="xsd:string">P14TT-QZ289-GJFQQ-1DQLY</activation_key>
<creation_time xsi:type="xsd:string">2011-11-08 08:36:53</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"/>
<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">Feature1</name>
<version xsi:type="xsd:string">1.2</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>
<item xsi:type="ns1:Soap_LicenseOrder">
<customer_id xsi:type="xsd:int">9</customer_id>
<product_template_id xsi:type="xsd:int">2</product_template_id>
<activation_key xsi:type="xsd:string">A2PW8-67K0W-QZ289-70JUM</activation_key>
<creation_time xsi:type="xsd:string">2011-11-08 08:46:12</creation_time>
<license_type xsi:type="xsd:string">network</license_type>
<licensee_type xsi:type="xsd:string">fixed</licensee_type>
<licensee xsi:type="xsd:string">Licensee_taken</licensee>
<hostid_match_rate xsi:type="xsd:int">100</hostid_match_rate>
<activated_licenses_count xsi:type="xsd:int">0</activated_licenses_count>
<description xsi:type="xsd:string"/>
<Hostids SOAP-ENC:arrayType="ns1:Soap_Hostid[1]" xsi:type="ns1:ArrayOfSoap_Hostid">
<item xsi:type="ns1:Soap_Hostid">
<name xsi:type="xsd:string">Windows Product ID</name>
<min_amount xsi:type="xsd:int">0</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">Feature1</name>
<version xsi:type="xsd:string">1.2</version>
<expiration_type xsi:type="xsd:string">days_from_activation</expiration_type>
<expiration_date xsi:nil="true"/>
<additional_settings xsi:nil="true"/>
<enabled xsi:type="xsd:boolean">true</enabled>
<days_from_activation xsi:type="xsd:int">60</days_from_activation>
<count xsi:type="xsd:int">10</count>
</item>
<item xsi:type="ns1:Soap_Feature">
<name xsi:type="xsd:string">Feature2</name>
<version xsi:type="xsd:string">2.1</version>
<expiration_type xsi:type="xsd:string">days_from_activation</expiration_type>
<expiration_date xsi:nil="true"/>
<additional_settings xsi:nil="true"/>
<enabled xsi:type="xsd:boolean">true</enabled>
<days_from_activation xsi:type="xsd:int">2</days_from_activation>
<count xsi:type="xsd:int">1</count>
</item>
</Features>
</item>
</result_array>
<result_code xsi:type="xsd:int">0</result_code>
<result_string xsi:nil="true"/>
</return>
</ns1:FindLicenseOrderByActivationKeyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
|