GetMarginalImpactGroupTemplates Method

Retrieves a list of all marginal impact analysis templates in a given Business Unit and SQL Server Instance. Each template is a saved set of administrative boundary groups.

Syntax

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

Public Function GetMarginalImpactGroupTemplates( _
   ByVal request As GetMarginalImpactGroupTemplatesRequest _
) As GetMarginalImpactGroupTemplatesResponse

Dim instance As MarginalImpactServiceClient
Dim request As GetMarginalImpactGroupTemplatesRequest
Dim value As GetMarginalImpactGroupTemplatesResponse
 
value = instance.GetMarginalImpactGroupTemplates(request)

public GetMarginalImpactGroupTemplatesResponse GetMarginalImpactGroupTemplates( 
   GetMarginalImpactGroupTemplatesRequest request
)

Parameters

request: Contains a GetMarginalImpactGroupTemplatesRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID) and SQL Instance SID associated with the list of marginal impact analysis templates to retrieve.

Return Value

A GetMarginalImpactGroupTemplatesResponse containing a list of marginal impact analysis templates in the specified business unit and SQL Server instance.

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.

Example

The following example shows how to retrieve marginal impact analysis templates using the GetMarginalImpactGroupTemplates() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.LossAnalysis.Data;
using AIR.Services.MarginalImpact.Api;
            
class SnippetGetMarginalImpactGroupTemplatesRequest
{
    private static void GetMarginalImpactGroupTemplates(int businessUnitSid, int sqlInstanceSid)
    {
        MarginalImpactServiceClient client = new MarginalImpactServiceClient();
            
        GetMarginalImpactGroupTemplatesRequest request = new GetMarginalImpactGroupTemplatesRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
            
        GetMarginalImpactGroupTemplatesResponse response = client.GetMarginalImpactGroupTemplates(request);
     
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("------------------   Marginal Impact Templates  -----------------------");
            foreach (MarginalImpactTemplate obj in response.MarginalImpactTemplates)
            {
                Console.WriteLine("                                                ");
                Console.WriteLine(" Sid: " + obj.Sid);
                Console.WriteLine(" Name: " + obj.Name);
                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