SWS GetAppliedInsurance Method
Retrieves the insurance rental details for a unit that has insurance. If ‘Null’ is returned, then the rental item does not have insurance applied to it. This will retrieve the insurance rental id which can then be used to cancel the insurance if needed.
Parameters
Name | DataType | Is Required |
---|---|---|
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. | |
SendLetter | Boolean | Not used in this method. |
Description | Not used in this method. |
Returned Parameters
Name | DataType |
---|---|
TRAN_RENTALS | TRAN_RENTALS |
Description | The object that contains all the data for the rental. |
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 GetAppliedInsurance request object and a GetAppliedInsurance response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAppliedInsurance_Request request = new SWS.GetAppliedInsurance_Request();
SWS.GetAppliedInsurance_Response response;
Here’s my sample code of the Request object.
// GetAppliedInsurance Request
request.SiteID = 123456;
request.RentalID = 123456;
Finally we can call the method and pass across the login object and the request object to get our applied insurance. 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.GetAppliedInsurance(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.