DSAPIService

Click here for a complete list of operations.

GetAddressBookItems

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/3.0/dsapi.asmx HTTP/1.1
Host: na2.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/3.0/GetAddressBookItems"

<?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>
    <GetAddressBookItems xmlns="http://www.docusign.net/API/3.0">
      <AccountID>string</AccountID>
    </GetAddressBookItems>
  </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>
    <GetAddressBookItemsResponse xmlns="http://www.docusign.net/API/3.0">
      <GetAddressBookItemsResult>
        <AddressBookItem>
          <AddressBookID>string</AddressBookID>
          <Email>string</Email>
          <UserName>string</UserName>
          <AccountName>string</AccountName>
          <Shared>boolean</Shared>
          <Created>dateTime</Created>
          <Owner>boolean</Owner>
          <Phone1>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone1>
          <Phone2>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone2>
          <Phone3>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone3>
          <Phone4>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone4>
        </AddressBookItem>
        <AddressBookItem>
          <AddressBookID>string</AddressBookID>
          <Email>string</Email>
          <UserName>string</UserName>
          <AccountName>string</AccountName>
          <Shared>boolean</Shared>
          <Created>dateTime</Created>
          <Owner>boolean</Owner>
          <Phone1>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone1>
          <Phone2>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone2>
          <Phone3>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone3>
          <Phone4>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone4>
        </AddressBookItem>
      </GetAddressBookItemsResult>
    </GetAddressBookItemsResponse>
  </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/3.0/dsapi.asmx HTTP/1.1
Host: na2.docusign.net
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>
    <GetAddressBookItems xmlns="http://www.docusign.net/API/3.0">
      <AccountID>string</AccountID>
    </GetAddressBookItems>
  </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>
    <GetAddressBookItemsResponse xmlns="http://www.docusign.net/API/3.0">
      <GetAddressBookItemsResult>
        <AddressBookItem>
          <AddressBookID>string</AddressBookID>
          <Email>string</Email>
          <UserName>string</UserName>
          <AccountName>string</AccountName>
          <Shared>boolean</Shared>
          <Created>dateTime</Created>
          <Owner>boolean</Owner>
          <Phone1>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone1>
          <Phone2>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone2>
          <Phone3>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone3>
          <Phone4>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone4>
        </AddressBookItem>
        <AddressBookItem>
          <AddressBookID>string</AddressBookID>
          <Email>string</Email>
          <UserName>string</UserName>
          <AccountName>string</AccountName>
          <Shared>boolean</Shared>
          <Created>dateTime</Created>
          <Owner>boolean</Owner>
          <Phone1>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone1>
          <Phone2>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone2>
          <Phone3>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone3>
          <Phone4>
            <PhoneNumber>string</PhoneNumber>
            <Designation>Home or Mobile or Work or Other or Fax</Designation>
          </Phone4>
        </AddressBookItem>
      </GetAddressBookItemsResult>
    </GetAddressBookItemsResponse>
  </soap12:Body>
</soap12:Envelope>