Archive
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.
SWS AddMultipleServices Method
Adds one or more rental item services (i.e., 24 Hour Access, Portable Lockers, Snail Mail Billing, etc.) to a rental item. Services are created by an admin in the Store application.
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. | |
| Services | ORG_SERVICE_SITE_OFFERINGS | Required |
| Description | An array of rental item services (i.e., 24 Hour Access, Snail Mail Billing, Portable Lockers, etc.) available at the site. This array can be obtained from the GetAvailableServices SWS method. | |
Returns
| Name | DataType |
|---|---|
| ProcessMessage | String |
| Description | A message that indicates the error that occurred while trying to add the rental item service. |
| Service | ORG_SERVICE_SITE_OFFERINGS |
| Description | The rental item service that was added to the rental. |
| ServiceObjectID | Long |
| Description | If the call failed to add a service, this will indicates the rental item service ID which was not added to the rental. |
| Succeeded | Boolean |
| Description | Indicates success (“True”) or failure (“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 AddMultipleServices request object and an AddMultipleServices response object. We can define and create those like this:
// Create request and response objects SWS.WSSoapClient service = new SWS.WSSoapClient(); SWS.AddMultipleService_Request request = new SWS.AddMultipleService_Request(); SWS.AddMultipleServices_Response[] response; // Our response from GetAvailableServices SWS.GetAvailableServices_Response get_serv_response = new SWS.GetAvailableServices_Response();
Now we set up the parameters for our request.
//Add multiple services request object
request.SiteID = 123456;
request.RentalID = 123456;
request.Service = new SWS.ORG_SERVICE_SITE_OFFERINGS[]
{ get_serv_response.Details[0], get_serv_response.Details[1] };
Finally we can call the method and pass across the login object and the request object to adding the multiple services. 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.AddMultipleServices(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.
Yardi Store Developer eXchange 