SWS GetAccountInfo Method
Retrieves a list of contacts and their details, for a specified account.
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_CLASS | String |
| Description | The account class. Available values:
|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| ACCT_NAME | String |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. |
| ACCT_TYPE | String |
| Description | The system-defined account type. Available values:
|
| ACTIVE | String |
| Description | Indicates if the contact is active (“Y”) or not (“N”). |
| CONTACT_ID | Long |
| Description | The rental contact’s ID number. |
| CONTACT_TYPE | String |
| Description | The rental contact type. Available values:
|
| CREATED_BY | Long |
| Description | The Store user’s ID that created the contact. |
| FIRST_NAME | String |
| Description | The first name for the contact. |
| KNOWN_AS | String |
| Description | The alternate or nick name for the contact. |
| LAST_NAME | String |
| Description | The last name for the rental contact. |
| UPDATED_BY | Long |
| Description | The Store user’s ID number that last updated the field. |
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 AccountInfo request object and a GetAccountInfo 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.GetAccountInfo_Response response;
Note: When there is more than one contact on an account the ContactID should be specified to return correct information. Otherwise this method will return all account contacts but will not distinguish between primary and secondary contacts.
Here’s my sample code of the Request object.
// GetAccountInfo Request
request.AcctID = 123456;
Finally we can call the method and pass across the login object and the request object to get our account information. 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.GetAccountInfo(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.
Yardi Store Developer eXchange 