Home > API General, Contacts, Letters > SWS GetContactAddresses Method

SWS GetContactAddresses Method


Retrieves a collection of address data for a specified account or contact.

Parameters

Name DataType Is Required
AcctID Long Optional*
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
* Either AcctID or ContactID is required.
ContactID Long Optional*
Description The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method.
* Either AcctID or ContactID is required.

Returned Parameters

Name DataType
ACCT_CONTACT_ADDRESSES ACCT_CONTACT_ADDRESSES
Description A collection of address data associated with the rental contact.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a Account_Request object and a GetContactAddresses response object.  We can define and create those like this:

\\ Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.Account_Request request = new SWS.Account_Request();
SWS.GetContactAddresses_Response response;

Here’s my sample code of the Request object using the account ID.

\\ GetContactAddresses Request
request.AcctID = 123456;

Finally we can call the method and pass across the login object and the request object to get our contact addresses. It’s a good idea to do this in a Try Catch block.

\\ Call the method that will load the response object
try
{
  response = service.GetContactAddresses(user_request,request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: