SWS RemovePCD Method
Removes an applied promotion, credit or discount (PCD) from a rental item.
Parameters
Name | DataType | Is Required |
---|---|---|
AssessmentID | Long | Required |
Description | The ID of the assessement that should be removed. This can be retrieved using the GetAssessments method. | |
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 PCD was removed from the rental 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, a RemovePCD request object and a RemovePCD response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.RemovePCD_Request request = new SWS.RemovePCD_Request();
SWS.RemovePCD_Response response;
Here’s my sample code of the Request object.
// RemovePCD Request
request.SiteID = 123456;
request.AssessmentID = 123456;
Finally we can call the method and pass across the login object and the request object to remove our PCD. 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.RemovePCD(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.