SWS AddService Method
Adds a rental item service (i.e., 24 Hour Access, Invoicing, etc.) to a specified rental item. Rental services are created by an admin in the application and some services, such as invoicing, may not create a charge on the 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. | |
SiteID | Long | Required |
Description | The site’s ID number. This is found using the GetSiteList method. | |
Service | ORG_SERVICE_SITE_OFFERINGS | Required |
Description | The rental item service object obtained from the GetAvailableServices SWS method. |
Returned Parameters
Name | DataType |
---|---|
Succeeded | Boolean |
Description | Indicates whether the service was added successfully (“True”) or not (“False”). |
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, an AddService request object and an AddService response object. We can define and create those like this:
// Create request and response objects and call getservices (See GetAvailableServices for details)
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AddService_Request request = new SWS.AddService_Request();
SWS.AddService_Response response;
SWS.GetAvailableServices_Response service_response = service.GetAvailableServices(user_request, services_request);
Here’s my sample code of the Request object.
//Add a service to a rental
request.SiteID = 123456;
request.RentalID = 123456;
request.Service = service_response.Details[0];
Finally we can call the method and pass across the login object and the request object to adding a service. It’s a good idea to do this in a Try Catch block.
try
{
// Call the method that will load the response object
response = service.AddService(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.