SWS getReceiptRules Method
Retrieves a list of site-defined rules pertaining to receipts.
Parameters
| Name | Data Type | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | Data Type |
|---|---|
| ruleID | Long |
| Description | The rule’s ID number. |
| ruleName | String |
| Description | The name of the rule in the system. |
| desc | String |
| Description | The description of the rule. |
| currSiteValue | String |
| Description | The option that is currently assigned to the rule. |
| siteValueMeaning | String |
| Description | The textual value of the currSiteValue. If the textual value is a number it will be the same. |
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 getRules request object, and a getRules response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.getRules_Request request = new SWS.getRules_Request();
SWS.getRules_Response response;
Here’s a sample code of the request object:
// GetReceiptRules Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to retrieve the receipt rules for the specified site. 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.getReceiptRules(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 returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
Yardi Store Developer eXchange 