SWS getTenantLeaseList Method
Retrieves tenant lease document information for an entire site, account and/or rental item.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctID | Long | Optional* |
| Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. * Either account ID or rental ID are required. |
|
| EndDate | DateTime | Required |
| Description | The end date of the date range for which you are requesting the lease list. | |
| RentalID | Long | Optional* |
| Description | The rental item’s ID number. Adds a filter to only return leases for the specifed rental. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. * Either account ID or rental ID are required. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. Adds a filter for all leases at the site. This can be found using the GetSiteList method. | |
| StartDate | DateTime | Required |
| Description | The first date of the date range for which you are requesting the lease list. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| CREATED | DateTime |
| Description | The date and time the lease was created. |
| LEASE_DEF_ID | Long |
| Description | The lease template ID that was used to create the lease. |
| LEASE_ID | Long |
| Description | The specific ID for the generated lease. |
| LEASE_VERSION | Integer |
| Description | The version of the lease. Will be “1” unless modifications have been made to the template. |
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| WHO_CREATED | String |
| Description | The name of the person that generated the lease for the customer. |
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.
Yardi Store Developer eXchange 