You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

The GetProductList function is used to get a product list. The license order contains all information about Features and Templates defined for the product.

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

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

Return values

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

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:GetProductList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <token xsi:type="xsd:string">e84b130bcd3fdf26644064098acdf9f3e5a3bfaa</token>
         <offset xsi:type="xsd:int">0</offset>
      </ns:GetProductList>
   </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:GetProductListResponse>
         <return xsi:type="ns1:Soap_List_Product">
            <result_array SOAP-ENC:arrayType="ns1:Soap_Product[1]" xsi:type="ns1:ArrayOfSoap_Product">
               <item xsi:type="ns1:Soap_Product">
                  <name xsi:type="xsd:string">product1</name>
                  <version xsi:type="xsd:string">1</version>
                  <description xsi:type="xsd:string"/>
                  <ProductTemplates SOAP-ENC:arrayType="ns1:Soap_ProductTemplate[1]" xsi:type="ns1:ArrayOfSoap_ProductTemplate">
                     <item xsi:type="ns1:Soap_ProductTemplate">
                        <id xsi:type="xsd:int">1</id>
                        <name xsi:type="xsd:string">Default</name>
                     </item>
                  </ProductTemplates>
               </item>
            </result_array>
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:GetProductListResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels