The FindCustomerByName function is used to to find one or more existing customers using the customer name.

The customer name can be a partial entry (for example, to find "CustomerA" and "CustomerB" you could enter only "Cust") and is case-insensitive (for example, "customer" and "CUSTOMER" 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/1">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:FindCustomerByName soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <token xsi:type="xsd:string">de0429eab5b1f05ab72870bdf06a5733c35975e7</token>
         <name xsi:type="xsd:string">customer 1</name>
         <offset xsi:type="xsd:int">0</offset>
      </ns:FindCustomerByName>
   </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"
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:FindCustomerByNameResponse>
         <return xsi:type="ns1:Soap_Response_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">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>
            </result_array>
            <result_code xsi:type="xsd:int">0</result_code>
            <result_string xsi:nil="true"/>
         </return>
      </ns1:FindCustomerByNameResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels