GetDataQualityAnalysisAugmentationSummary Method

Retrieves a Touchstone® Data Quality Analysis Augmentation Summary that contains the category of data that Touchstone augmented, the number of Locations that Touchstone augmented, and the percent of Locations with data that Touchstone augmented.

Augmentation means adding information about individual properties in your portfolio where data is missing or when confidence in the existing data is low. You can augment building location, property value, and primary and secondary risk characteristics. Primary risk characteristics include building construction, occupancy, year built, height, and gross area. Secondary risk characteristics include roof geometry, roof cover, siding, and foundation type.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function GetDataQualityAnalysisAugmentationSummary( _
   ByVal request As GetDataQualityAnalysisAugmentationSummaryRequest _
) As GetDataQualityAnalysisAugmentationSummaryResponse

Dim instance As DataQualityAnalysisServiceClient
Dim request As GetDataQualityAnalysisAugmentationSummaryRequest
Dim value As GetDataQualityAnalysisAugmentationSummaryResponse
 
value = instance.GetDataQualityAnalysisAugmentationSummary(request)

public GetDataQualityAnalysisAugmentationSummaryResponse GetDataQualityAnalysisAugmentationSummary( 
   GetDataQualityAnalysisAugmentationSummaryRequest request
)

Parameters

request: Contains a GetDataQualityAnalysisAugmentationSummaryRequest that identifies the Touchstone-generated Analysis Sequential Identifier (SID) of the Data Quality Analysis containing the Augmentation Summary that you want to retrieve, along with the associated Business Unit SID and SQL Instance SID.

Return Value

A GetDataQualityAnalysisAugmentationSummaryResponse containing the Data Quality Analysis Augmentation Summary that you have requested.

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.

To find the Analysis SID to pass into this method, call the GetDataQualityAnalyses() method. Alternately, you can call the GetActivity() method. The Analysis SID is stored in the GetActivityResponse.Activity.AnalysisSid property.

Example

The following example shows how to retrieve a Touchstone Data Quality Analysis Augmentation Summary using the GetDataQualityAnalysisAugmentationSummary() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.DataQualityAnalysis.Api;
using AIR.Services.DataQualityAnalysis.Data;
            
class SnippetGetDataQualityAnalysisAugmentationSummaryRequest
{
    private static void GetAnalysisAugmentationSummary(int businessUnitSid, int sqlInstanceSid, int analysisSid)
    {
        DataQualityAnalysisServiceClient client = new DataQualityAnalysisServiceClient();
        GetDataQualityAnalysisAugmentationSummaryRequest request = new GetDataQualityAnalysisAugmentationSummaryRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.AnalysisSid = analysisSid;
        GetDataQualityAnalysisAugmentationSummaryResponse response = client.GetDataQualityAnalysisAugmentationSummary(request);
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (AugmentationSummary augmentation in response.AugmentationSummary.ResultSummary)
            {
                Console.WriteLine("Category Augmented: " + augmentation.RuleSubType);
                Console.WriteLine("# Location Augmented: " + augmentation.LocationUpdatedCount.ToString());
                Console.WriteLine("% Location Augmented: " + Math.Round(augmentation.LocationUpdatedPercent, 1).ToString());
            }
        }
    }
}

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

Reference

DataQualityAnalysisServiceClient Class
DataQualityAnalysisServiceClient Members