Home > API General, Rental/Reservation, Waitlist > SWS AddToWaitList Method

SWS AddToWaitList Method

This method will add an account to a site’s wait list. If a unit is vacated and someone is on the wait list for that unit, the unit will immediately be put into an “In-Process” status for the first account in the wait list. The rental must be completed to a “Rented” status before close of business or it will be abandoned during nightly processing. Once it is abandoned it will then go to the next person on the wait list. This will occur within five minutes of the rental being terminated and will occur even if the rental was terminated in error. A wait list record can be created for a specific unit, a unit of a specific size, a unit of a maximum price, or a unit of a specific Attribute1 or Attribute2.


Name DataType Is Required
SiteID Long  Required
Description The site’s ID number. This can be found using the GetSiteList method.
ACCT_ID Long  Required
Description The account’s ID number.  This can be found using the GetContacts method.
PHONE_ID Long  Required
Description The ID number of the phone. This can be found using the GetContacts method.
ADDR_ID Long  Required
Description The ID number of the address. This can be found using the GetContacts method.
CONTACT_ID Long  Required
Description The ID number of the contact. This can be found using the GetContacts method.
ACCT_EMAIL String  Optional*
Description The email address that will be used to notify the contact when the wait list is triggered. An email address must be supplied if EMAIL_NOTIFY is set to “Y”.
UNIT_ID Long  Optional*
Description The ID number of the unit to place on the wait list. If UNIT_ID is supplied as part of the request, the trigger values are ignored.
TRIGGER_TYPE String  Optional*
Description If the UNIT_ID is not supplied, then one of the following trigger types must be supplied, along with a corresponding TRIGGER_VALUE or TRIGGER_VALUE_ID.

Available trigger types:

  • Minimum_Sq_Ft
  • Max_Price
  • Primary_Attributes
  • Secondary_Attributes
TRIGGER_VALUE String  Optional*
Description Indicates the square footage of the unit or the maximum price for the unit being requested through the wait list.(Example: Trigger type of Minimum_Sq_Ft, trigger value of 1000 will return units of no less than 1000 square feet. Trigger type of Max_Price, trigger value of 50.00 will return units of no more than $50.00 per month for rent.)
TRIGGER_VALUE_ID Decimal  Optional*
Description Indicates the primary or secondary attribute that is being requesting through the wait list. This can be found using eUnitAttr01 for Primary_Attributes and eUnitAttr02 for Secondary_Attributes
EMAIL_NOTIFY String  Optional*
Description Set to “Y” if a email notification is to be sent. If set to “Y” the ACCT_EMAIL parameter must also be set. Defaults to “N”.
PHONE_NOTIFY String  Optional*
Description Set to “Y” if phone notification is to be completed. Default is “N”.
TASK_NOTIFY String  Optional*
Description Set to “Y” if a task is to be created. Defaults to “N”.
NOTE_NOTIFY String  Optional*
Description Set to “Y” if  a note on the account is to be created. Defaults to “N”.
TOP_PRIORITY String  Optional*
Description Set to “Y” if  top priority is desired. Defaults to “N”. This will override the wait list and put this request at the top but it is first come, first served.
NOTES String  Optional
Description Notes relating to the new wait list item.

Returned Parameters

Name DataType
Description Returns the message “Successfully added item to wait list.” when the item is added to the wait list. The message “A unit of the type requested is available.” is returned if unit is available based upon the parameters requested.


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 AddToWaitlist request object and an AddToWaitlist response object. We can define and create those like this:

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

Now we set up the parameters for our request.

// AddToWaitList Request
request.SITE_ID = 123456;
request.ACCT_ID = 123456;
request.PHONE_ID = 123456;
request.ADDR_ID = 123456;
request.CONTACT_ID = 123456;
request.ACCT_EMAIL = "first@co.com";
request.UNIT_ID = 123456;
request.EMAIL_NOTIFY = "Y";
request.PHONE_NOTIFY = "Y";

Finally we can call the method and pass across the login object and the request object to add the account to the waitlist. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
 response = service.AddToWaitList(user_request, request);
catch (Exception ex)

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 )

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