The GetCustomerList function is used to get a customer list.
This function requires a LAC administrator token, which is obtained using the Login function.
In addition, this function uses an offset. Customers are packed into arrays of 100 elements. You can use an offset greater than 0 to get additional customers. For example, if you have 321 customers, you would run this method 4 times using the offsets 0, 100, 200, 300. The first 3 responses will have 100 customers each, and the last response will have 21 customers.
Return values
On success, the result string contains the customer list as described above.
On failure, the result string contains an error message. See Return codes for further information on error messages.
Also see Soap_List_Customer the object that is the response for the GetCustomerList function.
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:GetCustomerList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<token xsi:type="xsd:string">e84b130bcd3fdf26644064098acdf9f3e5a3bfaa</token>
<offset xsi:type="xsd:int">0</offset>
</ns:GetCustomerList>
</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:GetCustomerListResponse>
<return xsi:type="ns1:Soap_List_Customer">
<result_array SOAP-ENC:arrayType="ns1:Soap_Customer[1]" xsi:type="ns1:ArrayOfSoap_Customer">
<item xsi:type="ns1:Soap_Customer">
<id xsi:type="xsd:int">2</id>
<name xsi:type="xsd:string">customerName</name>
<street xsi:type="xsd:string">street of Customer</street>
<zip_code xsi:type="xsd:string">55562</zip_code>
<city xsi:type="xsd:string">City Name</city>
<state xsi:type="xsd:string">State Name</state>
<country xsi:type="xsd:string">Country Name</country>
<phone_number xsi:type="xsd:string">223236</phone_number>
<fax_number xsi:type="xsd:string">223236</fax_number>
<vat_number xsi:type="xsd:string">123</vat_number>
<description xsi:type="xsd:string">some description</description>
<Contacts SOAP-ENC:arrayType="ns1:Soap_Contact[0]" xsi:type="ns1:ArrayOfSoap_Contact"/>
</item>
</result_array>
<result_code xsi:type="xsd:int">0</result_code>
<result_string xsi:nil="true"/>
</return>
</ns1:GetCustomerListResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>