Yardi Store Developer eXchange

Terminates a service for a specified rental item.

Parameters

Returned Parameters

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 TerminateService request object, and a TerminateService response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.TerminateService_Request request = new SWS.TerminateService_Request();
SWS.TerminateService_Response response;

Here is a sample code of the request object:

// TerminateService Request
request.SiteID = 123456;
request.ServiceRentalID = 213456;
request.ServiceType = SWS.serviceTypeVals.GATE_ACCESS;

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.TerminateService(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.