List Builder Service

Updated on 08 Apr 2024
1 Minute to read

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

WSDL:

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

Australian URL:

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

Methods:

SearchLists()
Use this method to search across lists.

ExecuteList()
Use this method to get the results of a list.

SearchLists()

Part Of: List Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchLists() function to get the lists inside Vin65. 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
ListID	UUID		UUID of the Vin65 List
ListName	String 50
DateModifiedFrom	DateTime
DateModifiedTo	DateTime
MaxRows	Integer	100
Page	Integer	1

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>
  <SearchLists>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ListID></ListID>
      <ListName></ListName> 
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchLists>
</soap:Body>
</soap:Envelope>

Sample Response:

 <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schem as.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchListsResponse>
    <SearchListsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Lists>
        <List>
          <DateAdded>2011-03-02T17:49:32.407Z</DateAdded>
          <DateModified>2011-03-02T17:49:32.407Z</DateModified>
          <ListID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</ListID>
          <ListName>Pinot Noir Buyers</ListName>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </List>
        <List>
          <DateAdded>2011-03-02T17:56:03.487Z</DateAdded>
          <DateModified>2011-03-02T17:56:03.487Z</DateModified>
          <ListID>ad1e2a90-0695-d7d6-a684-ba7fec9ca015</ListID>
          <ListName>Repeat Buyers</ListName>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </List>
      </Lists>
      <RecordCount>2</RecordCount>
    </SearchListsReturn>
  </SearchListsResponse>
</soapenv:Body>
</soapenv:Envelope>

ExecuteList()

Part Of: List Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the ExecuteList() function to return the contacts for the applicable list. Required fields are indicated by a '*'

Response is limited to a maximum of 10,000 records.

Parameters:

Attribute	Data Type	Description
WebsiteID	UUID	Available For Enterprise Webservices UUID of the Vin65 Website Not necessary if ListID is present Useful if searching by ListName and ListName is not unique across Enterprise
ListID*	UUID	UUID of the Vin65 List One of either the ListID or ListName is required.
ListName*	String 50	One of either the ListID or ListName is required.

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSche ma-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <ExecuteList>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>02FC83E3-5EB4-4AA7-A64A-9710BFD9A12A</WebsiteID>
      <ListName>Pinot Noir Buyers</ListName>
    </Request>
  </ExecuteList>
</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>
  <ExecuteListResponse>
    <ExecuteListReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Contacts>
        <Contact>
          <Address>105 Buffalo Dr.</Address>
          <Address2></Address2>
          <BirthDate/>
          <City>Elkhorn</City>
          <Company></Company>
          <ContactID>a1fdacec-ae9c-1825-b429-93b89f3919e7</ContactID>
          <CountryCode></CountryCode>
          <CustomerNumber>303015</CustomerNumber>
          <DateAdded>2012-06-26T17:17:48.993Z</DateAdded>
          <DateModified>2012-06-28T00:37:55.907Z</DateModified>
          <Email>stephen.bond@essai.com</Email>
          <FirstName>Elkhorn Elky</FirstName>
          <LastName>Airport</LastName>
          <Phone></Phone>
          <StateCode></StateCode>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <ZipCode>R0M 0N0</ZipCode>
        </Contact>
        <Contact>
          <Address>#200-34434 McConnell Road</Address>
          <Address2></Address2>
          <BirthDate>1901-01-01T08:00:00.000Z</BirthDate>
          <City>Abbotsford</City>
          <Company></Company>
          <ContactID>745d9c7a-a41b-cfa6-c34f-1b7002387b7e</ContactID>
          <CountryCode>CA</CountryCode>
          <CustomerNumber>24811</CustomerNumber>
          <DateAdded>2012-04-17T05:46:08.173Z</DateAdded>
          <DateModified>2013-01-04T16:05:02.507Z</DateModified>
          <Email>peter@vin65.com</Email>
          <FirstName>Peter</FirstName>
          <LastName>Andres</LastName>
          <Phone>604-852-8140</Phone>
          <StateCode>BC</StateCode>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <ZipCode>98295</ZipCode>
        </Contact>
      </Contacts>
      <RecordCount>2</RecordCount>
    </ExecuteListReturn>
  </ExecuteListResponse>
</soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

What's Next

Internal Service 3.01