GetBusinessUnits Method

Retrieves a list of the existing Business Units for which data is stored on the Database Server.

A Business Unit is a department, division, local office, or some other sub-group of an organization. You can define it any way you wish. The API analyzes data from a single Business Unit at a time.

Syntax

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

Public Function GetBusinessUnits( _
   ByVal request As GetBusinessUnitsRequest _
) As GetBusinessUnitsResponse

Dim instance As SecurityServiceClient
Dim request As GetBusinessUnitsRequest
Dim value As GetBusinessUnitsResponse
 
value = instance.GetBusinessUnits(request)

public GetBusinessUnitsResponse GetBusinessUnits( 
   GetBusinessUnitsRequest request
)

Parameters

request: Contains a GetBusinessUnitsRequest for a list of all existing Business Units for which data is stored on the Database Server.

Return Value

A GetBusinessUnitsResponse containing a list of Business Units for which data is stored on the Database Server.

Example

The following example shows how to retrieve a list of all Business Units for which data is stored on the Database Server using the GetBusinessUnits() method:

using System;
using System.Linq;
using AIR.Services.Common.Data;
using AIR.Services.Security.Api;
            
class SnippetGetBusinessUnitsRequest
{
    private void GetBusinessUnitSid(string businessUnitName)
    {
        SecurityServiceClient securityClient = new SecurityServiceClient();
        GetBusinessUnitsRequest request = new GetBusinessUnitsRequest();
        GetBusinessUnitsResponse response = securityClient.GetBusinessUnits(request);
        if (response.Status.Code == StatusCode.Success)
        {
            AIR.Services.Security.Data.BusinessUnit businessUnit = response.BusinessUnits.FirstOrDefault(s => s.Name.ToLower() == businessUnitName);
            if (businessUnit != null)
            {
                Console.WriteLine("SID: " + businessUnit.Sid);
            }
        }
    }
}

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

SecurityServiceClient Class
SecurityServiceClient Members