GetExposureConcentrationAnalysisDamageBands Method

Retrieves the Damage Bands for a Touchstone® Geospatial Analysis.

A Damage Band is a single element of a Damage Function, which describes the effect of a selected peril. It consists of a parameter, such as maximum wind speed, and its associated damage ratio, expressed as a number between 0.0 and 1.0.

The Geospatial Analysis for which you want to retrieve Damage Bands could have a Ring, Zone, or Event accumulator. Each result in the list of Geospatial Analysis Damage Bands contains the Damage Band ID, name, risk count, and accumulator type, as well as the total replacement value of the insured properties in the specified Damage Band.

Syntax

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

Public Function GetExposureConcentrationAnalysisDamageBands( _
   ByVal request As GetExposureConcentrationAnalysisDamageBandsRequest _
) As GetExposureConcentrationAnalysisDamageBandsResponse

Dim instance As ExposureConcentrationAnalysisServiceClient
Dim request As GetExposureConcentrationAnalysisDamageBandsRequest
Dim value As GetExposureConcentrationAnalysisDamageBandsResponse
 
value = instance.GetExposureConcentrationAnalysisDamageBands(request)

public GetExposureConcentrationAnalysisDamageBandsResponse GetExposureConcentrationAnalysisDamageBands( 
   GetExposureConcentrationAnalysisDamageBandsRequest request
)

Parameters

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

Return Value

A GetExposureConcentrationAnalysisDamageBandsResponse containing the Damage Bands that you have requested from a Geospatial Analysis, as well as information describing the actual paging layout of the Damage Bands.

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 Damage Bands from a Touchstone Geospatial Analysis using the GetExposureConcentrationAnalysisDamageBands() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.ExposureConcentrationAnalysis.Api;
using AIR.Services.ExposureConcentrationAnalysis.Data;
            
class SnippetGetExposureConcentrationAnalysisDamageBandsRequest
{
    private static void GetExposureConcentrationAnalysisDamageBands(int businessUnitSid, int sqlInstanceSid, int analysisSid)
    {
        ExposureConcentrationAnalysisServiceClient ecaClient = new ExposureConcentrationAnalysisServiceClient();
        GetExposureConcentrationAnalysisDamageBandsRequest request = new GetExposureConcentrationAnalysisDamageBandsRequest();
        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 };
        GetExposureConcentrationAnalysisDamageBandsResponse response = ecaClient.GetExposureConcentrationAnalysisDamageBands(request);
            
        if (response.Status.Code == StatusCode.Success)
        {
            foreach (DamageBandResult result in response.DamageBandResults)
            {
                Console.WriteLine("Damage Band ID: " + result.ID);
                Console.WriteLine("Name: " + result.Name);
                Console.WriteLine("Damage Ratio: " + result.DamageRatio);
                Console.WriteLine("Total Replacement Value: " + result.TotalReplacementValue);
                Console.WriteLine("Risk Count: " + result.RiskCount);
                Console.WriteLine("Location Count: " + result.LocationCount);
                Console.WriteLine("Peril: " + result.PerilDescription);
            }
        }
    }
}

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