API


Click here for a complete list of operations.

ListContactsInAddressBookWithFullData

Retrieves a list of contacts in a given address book, returning all data fields (slower; please consider ListContactsInAddressBook as a faster option). To list the contents of the "All Contacts" address book, select -1 as the addressBookId. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: r2-api.dotdigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListContactsInAddressBookWithFullData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ListContactsInAddressBookWithFullData xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressBookId>int</addressBookId>
      <select>int</select>
      <skip>int</skip>
    </ListContactsInAddressBookWithFullData>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ListContactsInAddressBookWithFullDataResponse xmlns="http://apiconnector.com">
      <ListContactsInAddressBookWithFullDataResult>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
      </ListContactsInAddressBookWithFullDataResult>
    </ListContactsInAddressBookWithFullDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: r2-api.dotdigital.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ListContactsInAddressBookWithFullData xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressBookId>int</addressBookId>
      <select>int</select>
      <skip>int</skip>
    </ListContactsInAddressBookWithFullData>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ListContactsInAddressBookWithFullDataResponse xmlns="http://apiconnector.com">
      <ListContactsInAddressBookWithFullDataResult>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
        <APIContact>
          <ID>int</ID>
          <Email>string</Email>
          <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
          <DataFields>
            <Keys xsi:nil="true" />
            <Values xsi:nil="true" />
          </DataFields>
          <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
          <EmailType>PlainText or Html</EmailType>
          <Notes>string</Notes>
        </APIContact>
      </ListContactsInAddressBookWithFullDataResult>
    </ListContactsInAddressBookWithFullDataResponse>
  </soap12:Body>
</soap12:Envelope>