Yardi Store Developer eXchange

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

Returned Parameters

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.