GetMarginalImpactGroupTemplate Method

Retrieves a set of administrative boundary groups saved as a marginal impact analysis template.

Syntax

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

Public Function GetMarginalImpactGroupTemplate( _
   ByVal request As GetMarginalImpactGroupTemplateRequest _
) As GetMarginalImpactGroupTemplateResponse

Dim instance As MarginalImpactServiceClient
Dim request As GetMarginalImpactGroupTemplateRequest
Dim value As GetMarginalImpactGroupTemplateResponse
 
value = instance.GetMarginalImpactGroupTemplate(request)

public GetMarginalImpactGroupTemplateResponse GetMarginalImpactGroupTemplate( 
   GetMarginalImpactGroupTemplateRequest request
)

Parameters

request: Contains a GetMarginalImpactGroupTemplateRequest that identifies the Touchstone-generated Template Sequential Identifier (SID) associated with the administrative boundary groups to retrieve.

Return Value

A GetMarginalImpactGroupTemplateResponse containing a list of administrative boundary groups in the specified marginal impact analysis template.

Remarks

To find the Template SID to pass into this method, call the GetMarginalImpactGroupTemplates() method.

Example

The following example shows how to retrieve a set of administrative boundary groups using the GetMarginalImpactGroupTemplateRequest() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.LossAnalysis.Data;
using AIR.Services.MarginalImpact.Api;
            
class SnippetGetMarginalImpactGroupTemplateRequest
{
    private static void GetMarginalImpactGroupTemplate(int businessUnitSid, int sqlInstanceSid, int templateSid)
    {
        MarginalImpactServiceClient client = new MarginalImpactServiceClient();
            
        GetMarginalImpactGroupTemplateRequest request = new GetMarginalImpactGroupTemplateRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.TemplateSid = templateSid;
            
        GetMarginalImpactGroupTemplateResponse response = client.GetMarginalImpactGroupTemplate(request);
     
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("------------------   Marginal Impact Template's Admin Boundary Groups -----------------------");
            foreach (AdminBoundaryGroup obj in response.AdminBoundaryGroups)
            {
                Console.WriteLine("                                                ");
                Console.WriteLine(" Sid : " + obj.AdminBoundarySid);
                Console.WriteLine(" Name : " + obj.TargetName);
                Console.WriteLine(" Perils Set : " + (int)obj.PerilSetCodes);
                Console.WriteLine("                                                ");
            }
        }
    }
}

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

MarginalImpactServiceClient Class
MarginalImpactServiceClient Members