Yardi Store Developer eXchange

Retrieves site rules pertaining to terminating a rental.

Parameters

Returned Parameters

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a GetEndRentalRules request object and a RULE_VALUES collection object for the response. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetEndRentalRules_Request request = new SWS.GetEndRentalRules_Request();
SWS.RULE_VALUES[] response;

Here’s my sample code of the Request object.

// GetEndRentalRules Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our end rental rules. 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.GetEndRentalRules(user_request,request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.