Yardi Store Developer eXchange

Retrieves tenant letter document information for an entire site, account and/or rental, excludes receipts unless centrally mailed.

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

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

Here is a sample code of the request object:

// GetTenantLetterList Request
request.SiteID = 123456;
request.RentalID = 123456;
request.StartDate = DateTime.Today.AddDays(-30);
request.EndDate = DateTime.Today;

Finally we can call the method and pass across the login object and the request object to retrieve our requested 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.getTenantLetterList(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 in the exception so it can be debugged.

For a full list of methods see SWS Methods.