The information on this page refers to SOAP version 2. This function does not exist in SOAP version 1. |
The FindCustomerByEmail function is used to to find one or more existing customers using a contact's email address.
The email can be a partial entry and is case-insensitive (for example, "contact@company.com" and "CONTACT@COMPANY.COM" 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_Customer, with result_array of type ArrayOfSoap_Customer.
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/2">
<soapenv:Header/>
<soapenv:Body>
<ns:FindCustomerByEmail soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<token xsi:type="xsd:string">df2591f40c8823065ab4492578a63ee8f91b60b8</token>
<email xsi:type="xsd:string">example</email>
<offset xsi:type="xsd:int">0</offset>
</ns:FindCustomerByEmail>
</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/2"
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:FindCustomerByEmailResponse>
<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">1875</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"/>
<description xsi:type="xsd:string"/>
<creation_time xsi:type="xsd:string">2012-10-09 07:39:57</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:39:57</update_time>
<Contacts SOAP-ENC:arrayType="ns1:Soap_Contact[1]" xsi:type="ns1:ArrayOfSoap_Contact">
<item xsi:type="ns1:Soap_Contact">
<id xsi:type="xsd:int">2328</id>
<name xsi:type="xsd:string">contact1</name>
<email xsi:type="xsd:string">example_email@x-formation.com</email>
<customer_id xsi:type="xsd:int">1875</customer_id>
<creation_time xsi:type="xsd:string">2012-10-09 07:40:41</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:44:23</update_time>
</item>
</Contacts>
<CustomTags SOAP-ENC:arrayType="ns1:Soap_CustomTag[1]" xsi:type="ns1:ArrayOfSoap_CustomTag">
<item xsi:type="ns1:Soap_CustomTag">
<tag_name xsi:type="xsd:string">SF_Id</tag_name>
<value xsi:type="xsd:string">not synchronised</value>
<creation_time xsi:type="xsd:string">2012-10-09 07:39:57</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:39:57</update_time>
</item>
</CustomTags>
</item>
<item xsi:type="ns1:Soap_Customer">
<id xsi:type="xsd:int">1876</id>
<name xsi:type="xsd:string">Customer 2</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"/>
<description xsi:type="xsd:string"/>
<creation_time xsi:type="xsd:string">2012-10-09 07:40:52</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:40:52</update_time>
<Contacts SOAP-ENC:arrayType="ns1:Soap_Contact[1]" xsi:type="ns1:ArrayOfSoap_Contact">
<item xsi:type="ns1:Soap_Contact">
<id xsi:type="xsd:int">2329</id>
<name xsi:type="xsd:string">contact1</name>
<email xsi:type="xsd:string">example@x-formation.com</email>
<customer_id xsi:type="xsd:int">1876</customer_id>
<creation_time xsi:type="xsd:string">2012-10-09 07:41:17</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:44:07</update_time>
</item>
</Contacts>
<CustomTags SOAP-ENC:arrayType="ns1:Soap_CustomTag[1]" xsi:type="ns1:ArrayOfSoap_CustomTag">
<item xsi:type="ns1:Soap_CustomTag">
<tag_name xsi:type="xsd:string">SF_Id</tag_name>
<value xsi:type="xsd:string">not synchronised</value>
<creation_time xsi:type="xsd:string">2012-10-09 07:40:52</creation_time>
<update_time xsi:type="xsd:string">2012-10-09 07:40:52</update_time>
</item>
</CustomTags>
</item>
</result_array>
<result_code xsi:type="xsd:int">0</result_code>
<result_string xsi:nil="true"/>
</return>
</ns1:FindCustomerByEmailResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>