Yardi Store Developer eXchange

Retrieves tenant lease document information for an entire site, account and/or rental item.

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 getTenantLeaseList 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.getTenantLeaseList_Response response;

Here is a sample code of the request object getting all items for an account:

// GetTenantLeaseList Request
request.SiteID = 123456;
request.AcctID = 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 the lease(s) for that specified account and 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.getTenantLeaseList(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.