The GetCustomerList function is used to get a customer list.
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_Customer, with result_array of type ArrayOfSoap_Customer.
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"> <soapenv:Header/> <soapenv:Body> <ns:GetCustomerList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <token xsi:type="xsd:string" |
...
>de0429eab5b1f05ab72870bdf06a5733c35975e7</token> <offset xsi:type="xsd:int">0</offset> </ns:GetCustomerList> </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" |
...
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_Response_List_Customer"> <result_array SOAP-ENC:arrayType="ns1:Soap_Customer |
...
[ |
...
2]" xsi:type="ns1:ArrayOfSoap_Customer"> <item xsi:type="ns1:Soap_Customer"> <id xsi:type="xsd:int">1</id> <name xsi:type="xsd:string">customer 1</name> <street xsi:type="xsd:string"/> <zip_code xsi:type="xsd:string"/> <city xsi:type="xsd:string"/> <state xsi:type="xsd:string"/> <country xsi:type="xsd:string"/> <phone_number xsi:type="xsd:string"/> <fax_number xsi:type="xsd:string"/> <vat_number xsi:type="xsd:string"/> <description xsi:type="xsd:string"/> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-04-25 09:52:44</update_time> <Contacts SOAP-ENC:arrayType="ns1:Soap_Contact[2]" xsi:type="ns1:ArrayOfSoap_Contact"> <item xsi:type="ns1:Soap_Contact"> <id xsi:type="xsd:int">1</id> <name xsi:type="xsd:string">contact 1</name> <email xsi:type="xsd:string">c1@test.com</email> <customer_id xsi:type="xsd:int">1</customer_id> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-04-25 09:52:44</update_time> </item> <item xsi:type="ns1:Soap_Contact"> <id xsi:type="xsd:int">2</id> <name xsi:type="xsd:string">contact2</name> <email xsi:type="xsd:string" |
...
>c2@test.com</email> <customer_id xsi:type="xsd:int">1</customer_id> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-04-25 09:52:44</update_time> </item> </Contacts> <CustomTags SOAP-ENC:arrayType="ns1:Soap_CustomTag[2]" xsi:type="ns1:ArrayOfSoap_CustomTag"> <item xsi:type="ns1:Soap_CustomTag"> <name xsi:type="xsd:string">Tag2</name> <value xsi:type="xsd:string">value2</value> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-05-14 15:09:02</update_time> </item> <item xsi:type="ns1:Soap_CustomTag"> <name xsi:type="xsd:string">Tag1</name> |
...
<value xsi:type="xsd:string">value1</value> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-05-14 15:09:02</update_time> </item> </CustomTags> </item> <item xsi:type="ns1:Soap_Customer"> <id xsi:type="xsd:int">2</id> <name xsi:type="xsd:string" |
...
>customer2</name> <street xsi:type="xsd:string"/> <zip_code xsi:type="xsd:string" |
...
/ |
...
> <city xsi:type="xsd:string" |
...
/ |
...
> <state xsi:type="xsd:string" |
...
/ |
...
> <country xsi:type="xsd:string" |
...
/ |
...
> <phone_number xsi:type="xsd:string" |
...
/ |
...
> <fax_number xsi:type="xsd:string" |
...
/ |
...
> <vat_number xsi:type="xsd:string"/> <description xsi:type="xsd:string"/> <creation_time xsi:type="xsd:string" |
...
>2012-04-25 09:52:44</creation_time> |
...
<update_time xsi:type="xsd:string" |
...
>2012-04-25 09:52:44</update_time> <Contacts SOAP-ENC:arrayType="ns1:Soap_Contact |
...
[ |
...
2]" xsi:type="ns1:ArrayOfSoap_Contact"> <item xsi:type="ns1:Soap_Contact"> <id xsi:type="xsd:int">3</id> <name xsi:type="xsd:string">contact1</name> <email xsi:type="xsd:string">con1@test.com</email> <customer_id xsi:type="xsd:int">2</customer_id> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-04-25 09:52:44</update_time> </item> <item xsi:type="ns1:Soap_Contact"> <id xsi:type="xsd:int">4</id> <name xsi:type="xsd:string">contact3</name> <email xsi:type="xsd:string">con3@test.com</email> <customer_id xsi:type="xsd:int">2</customer_id> <creation_time xsi:type="xsd:string">2012-04-25 09:52:44</creation_time> <update_time xsi:type="xsd:string">2012-04-25 09:52:44</update_time> </item> </Contacts> </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> |
with result array of type \\