GetRingExposureConcentrationAnalysisResults Method

Retrieves the results of a Touchstone® Ring Geospatial Analysis, including the Ring ID and the data describing the Ring's centroid, such as its name, latitude, longitude, geocode match level, city, country, and postal code.

Syntax

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

Public Function GetRingExposureConcentrationAnalysisResults( _
   ByVal request As GetRingExposureConcentrationAnalysisResultsRequest _
) As GetRingExposureConcentrationAnalysisResultsResponse

Dim instance As ExposureConcentrationAnalysisServiceClient
Dim request As GetRingExposureConcentrationAnalysisResultsRequest
Dim value As GetRingExposureConcentrationAnalysisResultsResponse
 
value = instance.GetRingExposureConcentrationAnalysisResults(request)

public GetRingExposureConcentrationAnalysisResultsResponse GetRingExposureConcentrationAnalysisResults( 
   GetRingExposureConcentrationAnalysisResultsRequest request
)

Parameters

request: Contains a GetRingExposureConcentrationAnalysisResultsRequest that identifies the Touchstone-generated Analysis Sequential Identifier (SID) of the Ring Geospatial Analysis for which you want to retrieve the results, along with the associated Business Unit SID, SQL Instance SID, optional Paging Info, and optional Sorting Info.

Return Value

A GetRingExposureConcentrationAnalysisResultsResponse containing the results of the Ring Geospatial Analysis that you have requested, as well as information describing the actual paging layout of the analysis results.

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 GetActivity() method. The Analysis SID is stored in the GetActivityResponse.Activity.AnalysisSid property.

Example

The following example shows how to retrieve the results of a Touchstone Ring Geospatial Analysis using the GetRingExposureConcentrationAnalysisResults() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.ExposureConcentrationAnalysis.Api;
using AIR.Services.ExposureConcentrationAnalysis.Data;
            
class SnippetGetRingExposureConcentrationAnalysisResultsRequest
{
    private static void GetRingExposureConcentrationAnalysisResults(int businessUnitSid, int sqlInstanceSid, int analysisSid)
    {
        ExposureConcentrationAnalysisServiceClient ecaClient = new ExposureConcentrationAnalysisServiceClient();
        GetRingExposureConcentrationAnalysisResultsRequest request = new GetRingExposureConcentrationAnalysisResultsRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.AnalysisSid = analysisSid;
            
        /// Implement logic to loop through all the records.
        int page = 1; int pageSize = 20;
        request.PagingInfo = new PagingInfo { PageNumber = page, PageSize = pageSize };
        GetRingExposureConcentrationAnalysisResultsResponse response = ecaClient.GetRingExposureConcentrationAnalysisResults(request);
            
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (RingResult ring in response.RingResults)
            {
                Console.WriteLine("Accumulator SID: " + ring.ID);
                Console.WriteLine("Name: " + ring.Name);
                Console.WriteLine("Peril: " + ring.PerilDescription);
                Console.WriteLine("Total Risk Count: " + ring.RiskCount);
                Console.WriteLine("Total Replacement Value: " + ring.TotalReplacementValue);
            }
        }
    }
}

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

ExposureConcentrationAnalysisServiceClient Class
ExposureConcentrationAnalysisServiceClient Members