Home > API General, Letters, Rules, Site Administration > SWS GetProcessingMailRules Method

SWS GetProcessingMailRules Method


Retrieves a list of site rules for letters and the mailing process.

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
siteRuleData siteRuleData
Description  Array of items pertaining to the rule information.

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 my sample code of the Request object.

// getRules Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to retrieve our site rule data. 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.getProcessingMailRules(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.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: