TOP

SearchContacts()

Part Of: Contact Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/ContactService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/ContactService.cfc?wsdl

Description:

Use the SearchContacts() function to get a single contact or a list of contacts using the search options listed below. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteIDs UUID List   Available for Enterprise Webservices
Comma seperated list of WebsiteIDs in Enterprise
Leave blank for all Websites
ContactID UUID   UUID of the Vin65 Contact
AltContactID String 50    
CustomerNumber Integer    
FirstName String 50    
LastName String 50    
Company String 255    
City String 50    
StateCode String 50    
Phone String 50    
Email String 100    
EmailStatus String 50    
ContactType String 50    
DateModifiedFrom DateTime    
DateModifiedTo DateTime    
SortBy Enumerated
("LastName", "Company", "City", "StateCode", "Email", "CustomerNumber","LTV")
LastName  
MaxRows Integer 100  
Page Integer  

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchContacts>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ContactID></ContactID>
      <AltContactID></AltContactID>
      <CustomerNumber>1234</CustomerNumber>
      <FirstName></FirstName>
      <LastName></LastName>
      <Company></Company>
      <City></City>
      <StateCode></StateCode>
      <Phone></Phone>
      <Email></Email>
      <EmailStatus></EmailStatus>
      <ContactType></ContactType>
      <DateModifie dFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <SortBy>LastName</SortBy>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchContacts>
</soap:Body>
</soap:Envelope>  

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchContactsResponse>
    <SearchContactsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful> 
      <Contacts>
        <Contact>
          <Address>120 Wellington Rd.</Address>
          <Address2></Address2>
          <BirthDate/>
          <City>Sumas</City>
          <Company></Company>
          <ContactID>89eab9c7-a2c9-bfd7-e9e9-421b924a56f0</ContactID>
          <CountryCode>US</CountryCode>
          <CustomerNumber>1234</CustomerNumber>
          <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
          <DateModified>2011-04-19T16:50:12.507Z</DateModified>
          <Email>john.smith@gmail.com</Email>
          <EmailStatus>Double Opt In</EmailStatus>
          <FirstName>John</FirstName>
          <IsNonTaxable>true</IsNonTaxable>
          <LastLoginDate/>
          <LastName>Smith</LastName>
          <LastOrderDate>2012-04-23T21:29:03.000Z</LastOrderDate>
          <LifetimeValue>3463.89</LifetimeValue>
          <MasterContactID>3463.89</MasterContactID>
          <OrderCount>11</OrderCount>
          <Phone>604-852-8140</Phone>
          <StateCode>WA</StateCode>
          <SourceCode/>
          <Title/>
          <Username/>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <WholesaleNumber/>
          <ZipCode>98295</ZipCode>
        </Contact>
      </Contacts>
      <RecordCount>1</RecordCount>
    </SearchContactsReturn>
  </SearchContactsResponse>
</soapenv:Body>
</soapenv:Envelope>   

Page Top