Archive
SWS UpdateLeasePeriod Method
Updates the rental cycle date for a specified rental item. This SWS method checks the org/site rules and the rental item status and will not allow a change if the rental is delinquent, the rules do not allow it or if there has already been a rental cycle date change in the current rental cycle.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| NewStartDay | Integer | Required |
| Description | The new calendar day you want the rental cycle to start. For example, if the customer wants to make their payment on the 15th of the month just use “15” in this field. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| 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. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| NewLeaseThruDate | DateTime |
| Description | The new lease-thru-date (LTD) of the rental. Note: New Cycle Start Date: 11/15/2017; New Lease Thru Date: 11/14/2017. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser reequest 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, an UpdateLeasePeriod request object, and an UpdateLeasePeriod response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateLeasePeriod_Request request = new SWS.UpdateLeasePeriod_Request();
SWS.UpdateLeasePeriod_Response response;
Here is a sample code of the request object:
// UpdateLeasePeriod Request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 126456;
request.NewStartDay = 6;
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.UpdateLeasePeriod(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.
SWS viewLeasePDF Method
Provides a URL to view the requested document.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| LeaseId | Long | Required |
| Description | The lease’s ID number. This can be found using the LEASE_DEF_ID from the getLeaseTemplateInfo method. | |
| 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. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| TntPdfFilePath | String |
| Description | The URL to where the lease document is stored. This is what a returned PDF lease path might look like:
https://csiapp1.centershift.com/qa40/letters/
1000082928_1303989475.pdf
|
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 viewLease request object, and a PdfFilePath response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ViewLease_Request request = new SWS.ViewLease_Request();
SWS.PdfFilePath_Response response;
Here is a sample code of the request object:
// ViewLeasePDF Request
request.SiteID = 123546;
request.RentalId = 123456;
request.LeaseId = 123456;
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.viewLeasePdf(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.
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.
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.
Yardi Store Developer eXchange 