Archive
SWS TerminateService Method
Terminates a service for a specified rental item.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| ServiceRentalID | Long | Required |
| Description | The rental ID number of the service that will be removed. This is RENTAL_ID parameter that is returned when using the GetAppliedServices method. | |
| ServiceType | serviceTypeVals | Required |
| Description | The type of service to be removed. This is the SERVICE_TYPE parameter that is returned when using the GetAppliedServices method. Available values:
|
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| Succeeded | Boolean |
| Description | Indicates if the service was removed from the account 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 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.
SWS GetAvailableServices Method
Retrieves a collection of available services and their data for a specified site.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ORG_SERVICE_SITE_OFFERINGS | ORG_SERVICE_SITE_OFFERINGS |
| Description | Object containing the details of available services. |
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 GetAvailableServices request object and a GetAvailableServices response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAvailableServices_Request request = new SWS.GetAvailableServices_Request();
SWS.GetAvailableServices_Response response;
Here’s my sample code of the Request object.
// GetAvailableServices Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get our available services. 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.GetAvailableServices(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 GetAppliedServices Method
Retrieves a list of services applied to a specified rental item.
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. | |
Returned Parameters
| Name | DataType |
|---|---|
| AMOUNT | Decimal |
| Description | The amount charged for the service. |
| CREATED_BY | Long |
| Description | The user’s id that added the service to the account. |
| EMAIL_CC | Boolean |
| Description | Only applicable on mailed invoices. Indicates if the customer wants an email in addition to the paper invoice (“True”) or not (“False”). |
| END_DATE | DateTime |
| Description | The date the customer terminated the service from their account. |
| ICON | String |
| Description | The URL for the site revenue class icon that displays in the Store application. |
| ITEM_NAME | String |
| Description | The service’s name as defined by the site. |
| LTD | DateTime |
| Description | The date through which the service is charged put not paid. |
| OBJ_TYPE | String |
| Description | The object type. |
| OBJECT_ID | Long |
| Description | The rental service’s ID number. |
| PARENT_RENTAL_ID | Long |
| Description | The ID for the rental to which the service applies. |
| PTD | DateTime |
| Description | The paid-thru-date of the service. |
| RENTAL_ID | Long |
| Description | The service item’s ID number. |
| SERVICE_TYPE | Decimal |
| Description | The service’s type. Available values:
|
| START_DATE | DateTime |
| Description | The date the service was added to the customer’s rental. |
| STATUS | Integer |
| Description | The numeric value of the status of the service. Available values:
|
| UPDATED_BY | Long |
| Description | The Store user’s ID number that last updated the service. |
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 GetAppliedServices request object and a GetAppliedServices response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAppliedServices_Request request = new SWS.GetAppliedServices_Request();
SWS.GetAppliedServices_Response response;
Here’s my sample code of the Request object.
// GetAppliedServices Request
request.SiteID = 123456;
request.RentalID = 123456;
Finally we can call the method and pass across the login object and the request object for applied services. 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.GetAppliedServices(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 GetAvailableDiscounts Method
Retrieves a collection of discount data for a specified rental item. This is specific to discounts and promotions, it does not include credits.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| RentalID | Long | Optional* |
| Description | The Rental_ID for which to retrieve possible discounts. Use this for existing rentals. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. * Either the Rental_ID or Unit_ID is required. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| UnitID | Long | Optional* |
| Description | The unit’s ID number. This is returned when you use any of the GetSiteUnitData calls and is maintained through rentals. * Either the Rental_ID or Unit_ID is required. |
|
Returned Parameters
| Name | DataType |
|---|---|
| APPL_BEST_PCD | APPL_BEST_PCD |
| Description | Returns the object containing the data for the method call. |
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 GetAvailableDiscounts request object and a GetAvailableDiscounts response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAvailableDiscounts_Request request = new SWS.GetAvailableDiscounts_Request();
SWS.GetAvailableDiscounts_Response response;
Here’s my sample code of the Request object.
// GetAvailableDiscounts Request for an available unit
request.OrgID = 123456;
request.SiteID = 123456;
request.UnitID = 123456;
Finally we can call the method and pass across the login object and the request object to retrieve our discounts. 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.GetAvailableDiscounts(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 