Home > Uncategorized > SWS GetWaitList Method

SWS GetWaitList Method


Retrieves the list of active accounts that are on the wait list for the given SiteID.

Parameters

Name DataType Is Required
SiteID Long  Required
Description  The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
WAITLIST_ID Long
Description The item’s wait list ID.
SITE_ID Long
Description The site’s ID number.
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.
PHONE_ID Long
Description The ID number of the phone.
ADDR_ID Long
Description The ID number of the address.
CONTACT_ID Long
Description The ID number of the contact.
ACCT_EMAIL String
Description The email address entered for the item on the wait list.
UNIT_ID Long
Description The unit’s ID number.
UNIT_NUM String
Description The unit’s number as assigned by the organization. This is not the Unit_ID.
UNIT_SIZE String
Description A description  of the unit’s size and type.(Example: 12X12 Storage.)
RENT_RATE Decimal
Description The current rate the unit costs per rental cycle.
TRIGGER_TYPE String
Description The description of the TRIGGER_TYPE used when added to the wait list if any.
TRIGGER_VALUE String
Description The description of the TRIGGER_VALUE used when added to the wait list if any.
TRIGGERED String
Description Indicates if wait list item has been triggered by unit becoming available.
NOTES String
Description Notes entered when adding item to the wait list.
TOP_PRIORITY Boolean
Description Indicates if the wait list item is a priority on the wait list.
TASK_NOTIFY Boolean
Description Indicates if a task is to be generated when wait list item has been triggered.
NOTE_NOTIFY Boolean
Description Indicates if a note is to be generated when wait list item has been triggered.
PHONE_NOTIFY Boolean
Description Indicates if the contact is to be notified by phone when wait list item has been triggered.
EMAIL_NOTIFY Boolean
Description Indicates if the contact is to be notified by email when wait list item has been triggered.

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 create our objects. We’ll need the standard service object, an GetWaitList request object and an GetWaitList response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetWaitList_Request request = new SWS.GetWaitList_Request();
SWS.GetWaitList_Response response;

Now we set up the parameters for our request.

// GetWaitList Request
request.SITE_ID = 123456;

Finally we can call the method and pass across the login object and the request object to get our wait list. 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.GetWaitList(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.

Categories: Uncategorized
  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: