Archive

Archive for the ‘Rules’ Category

SWS GetSiteRuleValue Method

April 20, 2011 1 comment

Retrieves the status of the rule to indicate if it’s active or not.

Parameters

Name DataType Is Required
Active Boolean Optional
Description Applies a filter for rules that are set to active (“True”) or not (“False”).
RuleID Long Required
Description The rule’s ID number. This can be found using the GetSiteRules method.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
Details String
Description The rule’s active value. This does not return the value meaning. Use the GetSiteRules method for a full description.

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 GetSiteRuleValue request object and a GetSiteRuleValue response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.Rules_Request request = new SWS.Rules_Request();
SWS.GetSiteRuleValue_Response response;

Here’s my sample code of the Request object.

// GetSiteRuleValues Request
request.SiteID = 123456;
request.RuleID = 123;

Finally we can call the method and pass across the login object and the request object to get our site rule values. 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.GetSiteRuleValue(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 getReceiptRules Method

April 20, 2011 Leave a comment

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.

SWS GetProcessingMailRules Method

April 20, 2011 Leave a comment

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.

SWS GetSiteRules Method

April 20, 2011 1 comment

Retrieves all site rules if using just the SiteID or all information for the specified rule if including the RuleID.

Parameters

Name DataType Is Required
Active Boolean Optional
Description Applies a filter for rules that are set to active (“True”) or not (“False”).
RuleID Long Optional
Description The rule’s ID number in the system.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
RULE_VALUES RULE_VALUES
Description The object containing all the information about the rule/rules.

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 GetSiteRules request object and a GetSiteRules response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.Rules_Request request = new SWS.Rules_Request();
SWS.GetSiteRules_Response response;

Here’s my sample code of the Request object to all pull rules for a site. Optional parameters are available to further narrow results.

// GetSiteRules Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our site rules. 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.GetSiteRules(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.