SWS getLeaseTemplateInfo Method
Retrieves a list of lease template/documents to be created/printed for a specific rental.
Parameters
Name | DataType | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number. | |
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. | |
TemplateLevel | templateLevelVals | Required |
Description | Document filter for available letters. Available values:
|
Returned Parameters
Name | DataType |
---|---|
CREATED | DateTime |
Description | The creation date and time. |
CURR_VERSION | Integer |
Description | The version of the letter if updates have occurred. |
LANGUAGE_ID | Integer |
Description | The numeric value for the language ID. Indicates the language of the specific lease. |
LANGUAGE_MEANING | String |
Description | The textual value of the LANGUAGE_ID. Indicates the language of the specific lease. |
LEASE_DEF_ID | Long |
Description | The lease document’s lease ID. |
LEASE_NAME | String |
Description | The lease document name. |
ORG_ID | Long |
Description | The organization’s ID number that owns the document. The org ID number 1 indicates a generic lease that was created by Store. |
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_MEANING | String |
Description | The state/province code in which the rental is located. (I.E., Alabama = AL, New Brunswick = NB or Armed Forces Africa = AE) |
STATUS | Integer |
Description | The numeric value of the lease status. |
STATUS_MEANING | String |
Description | The textual value of the lease status. |
UPDATED | DateTime |
Description | The date that the lease was last updated. |
WHO_CREATED | String |
Description | The name of the user that created the lease. |
WHO_UPDATED | String |
Description | The name of the user that last updated the lease. |
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 GetLeaseTemplateInfo request object, and a GetLeaseTemplateInfo response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.getLeaseTemplateInfo_Request request = new SWS.getLeaseTemplateInfo_Request();
SWS.getLeaseTemplateInfo_Response response;
Here’s a sample code of the request object:
// GetLeaseTemplateInfo Request
request.OrgID = 123456;
request.SiteID = 123456;
request.TemplateLevel = SWS.templateLevelVals.SITE_ONLY;
Finally we can call the method and pass across the login object and the request object to retrieve the specified lease 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.getLeaseTemplateInfo(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.