SWS GetEstimatedRefund Method
Retrieves potential refund amount for a terminated reservation. This is for reservations only and will return “0” for any currently occupied rental.
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. | |
Returned Parameters
| Name | DataType |
|---|---|
| EstimatedRefundAmount | Decimal |
| Description | The refund amount is automatically calculated by the Store application, based on the refund rules for the site. This is from the CancelReservation SWS method. |
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 GetEstimatedRefund request object and a GetEstimatedRefund response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetEstimatedRefund_Request request = new SWS.GetEstimatedRefund_Request();
SWS.GetEstimatedRefund_Response response;
Here’s my sample code of the Request object.
// GetEstimatedRefund Request
request.RentalID = 123456;
Finally we can call the method and pass across the login object and the request object to get our estimated refund. 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.GetEstimatedRefund(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.
