Touchstone Re 2023 API Reference
GetRuleSets Method
Example 


Air.Services.Proxy Assembly > (Global) Namespace > RuleSetManagementServiceClient Class : GetRuleSets Method
Contains a GetRuleSetsRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID) and SQL Instance SID associated with the list of Rule Sets that you want to retrieve.
Retrieves a list of all existing Touchstone® Rule Sets for a given Business Unit and SQL Server Instance.

Rule Sets enable you to find out whether your exposure data is missing information and whether any of your data contains invalid combinations of attributes. In addition, Rule Sets enable Touchstone to update key Location attributes that can affect modeled losses. There are the following types of Rule Sets:

Rules Set Type Description
Completeness Rules Check exposure data for missing values or for user-specified values that might significantly impact modeled losses. For example, a missing street address, street number, city, or postal code, or a user-specified value for any of these fields.
Reasonability Rules Compare attributes to look for mismatched data, such as a construction type that is not compatible with the age of the building. For example, reinforced masonry construction was not used before 1950.
Augmentation Rules Improve the quality of exposure data by adding or replacing location information with user-specified values or data from the Data Quality Property-specific database if certain specified criteria are met. For example, "If replacement value for building changes, then update."
Location Update Rules Clear the current geocoding data and match levels in your exposure data, including latitude, longitude, and geocode match level data.
Syntax
Public Function GetRuleSets( _
   ByVal request As GetRuleSetsRequest _
) As GetRuleSetsResponse
Dim instance As RuleSetManagementServiceClient
Dim request As GetRuleSetsRequest
Dim value As GetRuleSetsResponse
 
value = instance.GetRuleSets(request)
public GetRuleSetsResponse GetRuleSets( 
   GetRuleSetsRequest request
)

Parameters

request
Contains a GetRuleSetsRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID) and SQL Instance SID associated with the list of Rule Sets that you want to retrieve.

Return Value

A GetRuleSetsResponse containing a list of Rule Sets in the specified SQL Server Instance in the specified Business Unit.
Remarks
To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

Note: In addition to using the default Rule Sets, you can use the Touchstone user interface to create new Rule Sets.

Example
The following example shows how to retrieve a list of all Touchstone Rule Sets for a given Business Unit and SQL Server Instance using the GetRuleSets() method:
using System;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Data;
using AIR.Services.DataQualityAnalysis.RuleSetManagement.Api;
            
class SnippetGetRuleSetsRequest
{
    private static void GetRuleSets(int businessUnitSid, int sqlInstanceSid)
    {
        RuleSetManagementServiceClient client = new RuleSetManagementServiceClient();
        GetRuleSetsRequest request = new GetRuleSetsRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        GetRuleSetsResponse response = client.GetRuleSets(request);
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (RuleSetSummary ruleSet in response.RuleSetSummaries)
            {
                Console.WriteLine("SID: " + ruleSet.Sid);
                Console.WriteLine("Name: " + ruleSet.Name);
            }
        }
    }
}
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

RuleSetManagementServiceClient Class
RuleSetManagementServiceClient Members