Get address book contact count

The GetAddressBookContactCount method can be used to get the number of contacts in a specified address book.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser-908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
addressBookId	int	The ID of the address book that you want to get the count of contacts within it.	required

Return values

result

int

The number of contacts in the specificied address book

Error responses

ERROR_ADDRESSBOOK_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

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

Example of use in C# .NET

/// <summary>
/// This method can be used to get the number of contacts in a specified address book. 
/// 
/// In this example, the contacts for each address book are discovered.
/// </summary>
public void GetAddressBookContactCount() 
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Console.WriteLine("GetAddressBookContactCount");
    Console.WriteLine("--------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // First - get a list of the address book in the account.
        com.apiconnector.APIAddressBook[] addrBooks = api.ListAddressBooks(username, password);
 
        if (addrBooks != null && addrBooks.Length > 0)
        {
            foreach (com.apiconnector.APIAddressBook book in addrBooks)
            {
                // now get the contact count for the address book
                int contactCount = api.GetAddressBookContactCount(username, password, book.ID);
 
                Console.WriteLine("Address Book [{0} - {1}] Contact Count: {2}", book.Name, book.ID, contactCount);
            }
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/GetAddressBookContactCount"
<?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>
    <GetAddressBookContactCount xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressbookid>int</addressbookid>
    </GetAddressBookContactCount>
  </soap:Body>
</soap:Envelope>

Sample response

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>
    <GetAddressBookContactCountResponse xmlns="http://apiconnector.com">
      <GetAddressBookContactCountResult>int</GetAddressBookContactCountResult>
    </GetAddressBookContactCountResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Get address book contact count

The GetAddressBookContactCount method can be used to get the number of contacts in a specified address book.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: