The information on this page refers to SOAP version 4. This function did not exist in previous SOAP versions. |
The FindLicenseOrderByCustomerId function is used to to find one or more license orders by customer ID.
This function will allow multiple customer IDs to be specified, but does not allow partial entry of the customer ID.
This function uses an offset and requires a login token, which is obtained using the Login function.
Setting the "exclude" parameter to "false" will return only the license order(s) that correspond with the specified customerIds parameter value(s). Setting the "exclude" parameter to "true" will return all license orders except those specified in the customerIds parameter value(s).
Return values
The response is of the type Soap_Response_List_LicenseOrder, with result_array of type ArrayOfSoap_LicenseOrder .
Example request
<soapenv:Header/> <soapenv:Body> <ns:FindLicenseOrderByCustomerId soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <token xsi:type="xsd:string">5eb73c9cd45e7c11494afa3c545be9ca331ab165</token> <customerIds xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:int">1020</item> <item xsi:type="xsd:int">546</item> </customerIds> <exclude xsi:type="xsd:boolean">false</exclude> <offset xsi:type="xsd:int">0</offset> </ns:FindLicenseOrderByCustomerId> </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/4"
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:FindLicenseOrderByCustomerIdResponse>
<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">1</customer_id>
<product_template_id xsi:type="xsd:int">1</product_template_id>
<activation_key xsi:type="xsd:string">TQ3I2-386PT-MRSJT-UDNCG</activation_key>
<creation_time xsi:type="xsd:string">2019-02-12 09:19: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>
<activations_allowed xsi:type="xsd:int">1</activations_allowed>
<activated_licenses_count xsi:type="xsd:int">0</activated_licenses_count>
<enabled xsi:type="xsd:boolean">true</enabled>
<description xsi:type="xsd:string"/>
<settings_description xsi:nil="true"/>
<removal xsi:type="xsd:boolean">false</removal>
<removal_request_time xsi:nil="true"/>
<removal_confirmation_time xsi:nil="true"/>
<deactivations_allowed xsi:type="xsd:int">0</deactivations_allowed>
<deactivations_left xsi:type="xsd:int">0</deactivations_left>
<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">Feature 1</name>
<version xsi:type="xsd:string">1.0</version>
<expiration_type xsi:type="xsd:string">no_expiration</expiration_type>
<expiration_date xsi:nil="true"/>
<issued_type xsi:type="xsd:string">not_issued</issued_type>
<issued_date xsi:nil="true"/>
<options 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"/>
<maintenance_type xsi:type="xsd:string">no_maintenance</maintenance_type>
<maintenance_date xsi:nil="true"/>
<maintenance_days_from_activation xsi:nil="true"/>
<comment xsi:nil="true"/>
</item>
</Features>
</item>
<item xsi:type="ns1:Soap_LicenseOrder">
<customer_id xsi:type="xsd:int">2</customer_id>
<product_template_id xsi:type="xsd:int">2</product_template_id>
<activation_key xsi:type="xsd:string">RUVEV-OMJ8K-1STJI-ALB47</activation_key>
<creation_time xsi:type="xsd:string">2019-02-12 09:20:04</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>
<activations_allowed xsi:type="xsd:int">1</activations_allowed>
<activated_licenses_count xsi:type="xsd:int">0</activated_licenses_count>
<enabled xsi:type="xsd:boolean">true</enabled>
<description xsi:type="xsd:string"/>
<settings_description xsi:nil="true"/>
<removal xsi:type="xsd:boolean">false</removal>
<removal_request_time xsi:nil="true"/>
<removal_confirmation_time xsi:nil="true"/>
<deactivations_allowed xsi:type="xsd:int">0</deactivations_allowed>
<deactivations_left xsi:type="xsd:int">0</deactivations_left>
<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">Feature 2</name>
<version xsi:type="xsd:string">1.0</version>
<expiration_type xsi:type="xsd:string">no_expiration</expiration_type>
<expiration_date xsi:nil="true"/>
<issued_type xsi:type="xsd:string">not_issued</issued_type>
<issued_date xsi:nil="true"/>
<options 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"/>
<maintenance_type xsi:type="xsd:string">no_maintenance</maintenance_type>
<maintenance_date xsi:nil="true"/>
<maintenance_days_from_activation xsi:nil="true"/>
<comment xsi:nil="true"/>
</item>
</Features>
</item>
</result_array>
<result_code xsi:type="xsd:int">0</result_code>
<result_string xsi:nil="true"/>
</return>
</ns1:FindLicenseOrderByCustomerIdResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>