SubmitCustomBoundaryExposureConcentrationAnalysis Method

Submits a new Touchstone® Custom Boundary Geospatial Analysis job.

The Custom Boundary Geospatial API is the most flexible analysis service that enables you to customize the Boundary data type. You can use it in many real-world situations such as in the import of administrative boundaries, hazard zones, disaster events, etc. Just as with events, you can accumulate against boundaries (assigning damage ratios). This Boundary data type is also useful if you want to analyze an imported shapefile for different perils. You assign perils for imported custom boundaries.

Syntax

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

Public Function SubmitCustomBoundaryExposureConcentrationAnalysis( _
   ByVal request As SubmitCustomBoundaryExposureConcentrationAnalysisRequest _
) As SubmitCustomBoundaryExposureConcentrationAnalysisResponse

Dim instance As ExposureConcentrationAnalysisServiceClient
Dim request As SubmitCustomBoundaryExposureConcentrationAnalysisRequest
Dim value As SubmitCustomBoundaryExposureConcentrationAnalysisResponse
 
value = instance.SubmitCustomBoundaryExposureConcentrationAnalysis(request)

public SubmitCustomBoundaryExposureConcentrationAnalysisResponse SubmitCustomBoundaryExposureConcentrationAnalysis( 
   SubmitCustomBoundaryExposureConcentrationAnalysisRequest request
)

Parameters

request: Contains a SubmitCustomBoundaryExposureConcentrationAnalysisRequest that identifies the Business Unit SID, SQL Instance SID and the analysis Options to configure the geospatial analysis.
The Options property contains a CustomBoundaryAnalysisOptions object that enables you to specify the custom boundary parameters and perils associated with the geospatial analysis request.

Return Value

A SubmitCustomBoundaryExposureConcentrationAnalysisResponse containing the Activity SID that uniquely identifies the asynchronous web service call that you made to submit the specified Custom Boundary Geospatial Analysis job.

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.

For information about retrieving the results of a Touchstone Custom Boundary Geospatial Analysis, see the GetCustomBoundaryResults() method.

Example

using AIR.Services.AnalysisCommon.Data;
 using AIR.Services.Common.Data;
 using AIR.Services.ExposureConcentrationAnalysis.Api;
 using AIR.Services.ExposureConcentrationAnalysis.Data;
 using System;
 using System.Collections.Generic;
            
 class SnippetSubmitCustomBoundaryExposureConcentrationAnalysis
 {
 private static void SubmitCustomBoundaryExposureConcentrationAnalysis(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)
    {
            
        if (response.CustomBoundaryOptions.Count gt; 0)
        {
            response.CustomBoundaryOptions.ForEach(x =gt; x.PerilSet = PerilSetCode.TropicalCyclone);
            
            SubmitCustomBoundaryExposureConcentrationAnalysisRequest req = new SubmitCustomBoundaryExposureConcentrationAnalysisRequest();
            req.BusinessUnitSid = businessUnitSid;
            req.SqlInstanceSid = sqlInstanceSid;
            req.Options = new CustomBoundaryAnalysisOptions()
            {
                Name = "Api Analysis " + new Random().Next(),
                Description = "Created by API at " + DateTime.Now.ToString("MMMM dd yyyy H mm ss"),
                ResultDataSourceSid = 1,
                ProjectSid = 1,
                Currency = "USD",
                CurrencyExchangeRateSid = 3,
                CustomBoundaryOptions = response.CustomBoundaryOptions,
                ExposureTarget = new ExposureTarget
                {
                    Sid = 1,
                    Type = ExposureTargetType.ExposureView
                }
            };
            SubmitCustomBoundaryExposureConcentrationAnalysisResponse res = client.SubmitCustomBoundaryExposureConcentrationAnalysis(req);
            if (res.Status.Code == StatusCode.Success)
                Console.WriteLine("Submitted Successfully to HPC with Activity ID: " + res.ActivitySid);
        }
            
    }
}
            
 }

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