Home > API General, Rules, Site Administration > SWS GetSiteRuleValue Method

SWS GetSiteRuleValue Method


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.

  1. No comments yet.
  1. January 18, 2013 at 3:21 pm

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: