API


Click here for a complete list of operations.

ListPublicAddressBooks

List all public address books for the current account.

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: api.dotdigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListPublicAddressBooks"

<?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>
    <ListPublicAddressBooks xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </ListPublicAddressBooks>
  </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>
    <ListPublicAddressBooksResponse xmlns="http://apiconnector.com">
      <ListPublicAddressBooksResult>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
      </ListPublicAddressBooksResult>
    </ListPublicAddressBooksResponse>
  </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: 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>
    <ListPublicAddressBooks xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </ListPublicAddressBooks>
  </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>
    <ListPublicAddressBooksResponse xmlns="http://apiconnector.com">
      <ListPublicAddressBooksResult>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
        <APIAddressBook>
          <ID>int</ID>
          <Name>string</Name>
        </APIAddressBook>
      </ListPublicAddressBooksResult>
    </ListPublicAddressBooksResponse>
  </soap12:Body>
</soap12:Envelope>