SWS getLeaseGroupTemplateInfo Method
Retrieves the lease template data via the rental item’s ID number.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| RentalID | Long | Required |
| Description | The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| COPIES | Integer |
| Description | The number of copies to print for each lease document in the lease group. |
| DESCRIPTION | String |
| Description | A brief description of the lease group’s documents. |
| DOC_ACTIVE | Boolean |
| Description | Indicates if the document in the lease group is active for the site (“True”) or not (“False”). |
| GROUP_ACTIVE | Boolean |
| Description | Indicates if the lease group is active at the organization (“True”) or not (“False”). |
| GROUP_DOC_ID | Long |
| Description | The lease group’s ID number. |
| GROUP_NAME | String |
| Description | The lease group’s name. |
| LANG_VAL | String |
| Description | The textual value of the LANGUAGE_ID. Available values:
|
| LANGUAGE_ID | Integer |
| Description | The numeric value for the language used in the lease group. Available values:
|
| LEASE_DEF_ID | Long |
| Description | The lease document’s lease definition number. |
| LEASE_GROUP_ID | Long |
| Description | The lease group’s ID number. |
| LEASE_NAME | String |
| Description | The lease’s name. |
| ORG_ID | Long |
| Description | The organization’s ID number. |
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| STATE_ID | Integer |
| Description | The system assigned numeric value of the state/province in which the rental is located. |
| STATE_VAL | String |
| Description | The state/province code for which the rental is located. |
| STATUS | Integer |
| Description | The numeric value of the current rental status of the unit. |
| UNIT_ID | Long |
| Description | The unit’s ID number. This is maintained through rentals. |
| UNIT_NUMBER | String |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. |
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 GetLeaseGroupTemplateInfo request object, and a GetLeaseGroupTemplateInfo response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.getLeaseGroupTemplateInfo_Request request = new SWS.getLeaseGroupTemplateInfo_Request();
SWS.getLeaseGroupTemplateInfo_Response response;
Here’s a sample code of the request object:
// GetLeaseGroupTemplateInfo Request
request.RentalID = 123456;
Finally we can call the method and pass across the login object and the request object to retrieve the lease group template 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.getLeaseGroupTemplateInfo(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.
Yardi Store Developer eXchange 