GetAddressBookItems

These methods can be used to manage your server side address book in the Docusign system. You will be able to retrieve address book entries.

Schema

// This is simple -- just input your account ID
DocuSignWeb.AddressBookItem[] items =
    _apiClient.GetAddressBookItems(_accountId);
// Display information about the address book items
Console.WriteLine("There there are {0} items in the address book:", items.Length);
foreach (DocuSignWeb.AddressBookItem item in items)
{
    Console.WriteLine("\t{0}: {1}", item.UserName, item.Email);
}

Name	Schema Type	Description
AccountID	DSXId	Account ID information

Retrieves your address book and account shared address book. This method returns an array of AddressBookItem objects.

AddressBookItem

Schema

Name	Schema Type	Description
AddressBookID	DSXId	Unique identifier of the address book item. This can be a maximum of 100 characters.
Email	String	Email associated with the address book item. This can be a maximum of 100 characters.
UserName	String	Name associated with the address book item. This can be a maximum of 100 characters.
AccountName	String	Account name associated with the address book item. This can be a maximum of 100 characters.
Shared	Boolean	True if the address book item is shared with the API user’s account.
Created	DateTime	Date the address book item was created.
Owner	Boolean	True if the API user account is the owner of the address book item.
Phone1	AddressBookPhone	PhoneNumber: string: phone number, maximum length is 20. PhoneNumberDesignation: value: one of the following: Home, Mobile, Work, Fax, Other.
Phone2	AddressBookPhone	PhoneNumber: string: phone number, maximum length is 20. PhoneNumberDesignation: value: one of the following: Home, Mobile, Work, Fax, Other.
Phone3	AddressBookPhone	PhoneNumber: string: phone number, maximum length is 20. PhoneNumberDesignation: value: one of the following: Home, Mobile, Work, Fax, Other.
Phone4	AddressBookPhone	PhoneNumber: string: phone number, maximum length is 20. PhoneNumberDesignation: value: one of the following: Home, Mobile, Work, Fax, Other.

Rules and exceptions for GetAddressBookItems

Account_Lacks_Permissions – account does not have permissions to use this API.
User_Lacks_Permissions – user does not have permissions to use this API.
Address book items that are passed to this API that the user does not own will not be removed.