GetCustomBoundariesDetails Method

Retrieves details of each custom boundaries.

The Custom Boundaries are particularly useful when you import your own vector or raster data as a Boundary data type and inspect accumulation on the same exposures within the boundary.

Syntax

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

Public Function GetCustomBoundariesDetails( _
   ByVal request As GetCustomBoundariesDetailsRequest _
) As GetCustomBoundariesDetailsResponse

Dim instance As ExposureConcentrationAnalysisServiceClient
Dim request As GetCustomBoundariesDetailsRequest
Dim value As GetCustomBoundariesDetailsResponse
 
value = instance.GetCustomBoundariesDetails(request)

public GetCustomBoundariesDetailsResponse GetCustomBoundariesDetails( 
   GetCustomBoundariesDetailsRequest request
)

Parameters

request: Contains a GetCustomBoundariesDetailsRequest that identifies the Business Unit SID, SQL Instance SID, and list of Custom Boundary SIDs for which you want to obtain more details.

Return Value

A GetCustomBoundariesDetailsResponse containing the Custom Boundary Options such as the custom boundary name, unique SID, spatial shape dataset, the user-assigned peril, and legend data of the custom boundary SIDs specified in the request job.

Remarks

You must specify valid unique custom boundary SIDs in your request. A request with duplicate custom boundary SIDs fails

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.

For information about retrieving the custom boundaries, see the GetCustomBoundariesDetails() method.

Example

using AIR.Services.Common.Data;
             using AIR.Services.ExposureConcentrationAnalysis.Api;
             using System;
             using System.Collections.Generic;
            
             class SnippetGetCustomBoundariesDetails
             {
             private static void GetCustomBoundariesDetails(int businessUnitSid, int sqlInstanceSid, Listlt;intgt; customBoundarySids)
             {
             ExposureConcentrationAnalysisServiceClient client = new ExposureConcentrationAnalysisServiceClient();
             GetCustomBoundariesDetailsRequest request = new GetCustomBoundariesDetailsRequest();
             request.BusinessUnitSid = businessUnitSid;
             request.SqlInstanceSid = sqlInstanceSid;
             request.Sids = customBoundarySids;
             GetCustomBoundariesDetailsResponse response = client.GetCustomBoundariesDetails(request);
                if (response.Status.Code == StatusCode.Success)
                {
                    foreach (var cb in response.CustomBoundaryOptions)
                    {
             Console.WriteLine("Sid: " + cb.Sid);
             Console.WriteLine("Name: " + cb.Name);
             Console.WriteLine("Perils: " + cb.PerilSet);
             Console.WriteLine("-------Legends-------");
                        foreach (var l in cb.LegendItems)
                        {
             Console.WriteLine("Sid: " + l.Sid);
             Console.WriteLine("Label: " + l.Label);
             Console.WriteLine("Damage Ratios: " + l.DamageRatio);
            
             }
             }
             }
            
             }
             }

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