GetAdminBoundaries Method

Retrieves a list of all user-defined administrative boundaries in a given Business Unit and SQL Server Instance.

Syntax

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

Public Function GetAdminBoundaries( _
   ByVal request As GetAdminBoundariesRequest _
) As GetAdminBoundariesResponse

Dim instance As MarginalImpactServiceClient
Dim request As GetAdminBoundariesRequest
Dim value As GetAdminBoundariesResponse
 
value = instance.GetAdminBoundaries(request)

public GetAdminBoundariesResponse GetAdminBoundaries( 
   GetAdminBoundariesRequest request
)

Parameters

request: Contains a GetAdminBoundariesRequest that identifies the Touchstone-generated Business Unit Sequential Identifier (SID) and SQL Instance SID associated with the list of administrative boundaries to retrieve.

Return Value

A GetAdminBoundariesResponse containing a list of administrative boundary details 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 administrative boundaries using the GetAdminBoundaryRequest() method:

using System;
using AIR.Services.Common.Data;
using AIR.Services.LossAnalysis.Data;
using AIR.Services.MarginalImpact.Api;
            
class SnippetGetAdminBoundariesRequest
{
    private static void GetAdminBoundaries(int businessUnitSid, int sqlInstanceSid)
    {
        MarginalImpactServiceClient client = new MarginalImpactServiceClient();
 
        GetAdminBoundariesRequest request = new GetAdminBoundariesRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
            
        GetAdminBoundariesResponse response = client.GetAdminBoundaries(request);
    
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("------------------   Boundary Details  -----------------------");
            foreach (AdminBoundary obj in response.AdminBoundaryDetails)
            {
                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