Yardi Store Developer eXchange

Retrieves a list of letters scheduled to be created in the future. This list does not include receipts, invoices or lease documents.

Parameters

Returned Parameters

Example

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

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, a GetScheduledLetterList request object, and a GetScheduledLetterList response object. We can define and create those like this:

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

Here’s my sample code of the Request object.

// GetScheduledLetterList Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to retrieve the scheduled letters for the specified rental. 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.getScheduledLetterList(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.