Yardi Store Developer eXchange

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.

Parameters

Returned Parameters

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 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
try
{
 response = service.AddToWaitList(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.