GetCompanyUserDefinedCategories Method

Retrieves a collection of user defined categories for companies in Touchstone Re.

A user-defined category (UDC) enables you to group and classify large portfolios into chunks of smaller portfolios.

Each company or program can have up to five categories.

Each category can have one out of 250 classifications.

Syntax

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

Public Function GetCompanyUserDefinedCategories( _
   ByVal request As GetCompanyUserDefinedCategoriesRequest _
) As GetCompanyUserDefinedCategoriesResponse

Dim instance As CompanyManagementServiceClient
Dim request As GetCompanyUserDefinedCategoriesRequest
Dim value As GetCompanyUserDefinedCategoriesResponse
 
value = instance.GetCompanyUserDefinedCategories(request)

public GetCompanyUserDefinedCategoriesResponse GetCompanyUserDefinedCategories( 
   GetCompanyUserDefinedCategoriesRequest request
)

Parameters

request: Contains a GetCompanyUserDefinedCategoriesRequest that specifies the Business Unit SID and SQL Instance SID for which you want to retrieve the categories.

Return Value

A GetCompanyUserDefinedCategoriesResponse that contains the list of categories for the BU specified in the request.

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.

To find the Company SID to pass into this method, call the GetCompanies() method.

Example

using AIR.Services.Common.Data;
using AIR.Services.Reinsurance.UserDefinedCategoryManagement.Api;
using System;
            
class SnippetGetCompanyUserDefinedCategories
{
private static void GetCompanyUserDefinedCategories(int businessUnitSid, int sqlInstanceSid)
{
CompanyManagementServiceClient client = new CompanyManagementServiceClient();
GetCompanyUserDefinedCategoriesRequest request = new GetCompanyUserDefinedCategoriesRequest();
request.BusinessUnitSid = businessUnitSid;
request.SqlInstanceSid = sqlInstanceSid;
GetCompanyUserDefinedCategoriesResponse response = client.GetCompanyUserDefinedCategories(request);
   if (response.Status.Code == StatusCode.Success)
   {
       foreach (var c in response.Categories)
       {
Console.WriteLine("UserDefinedCategorySid: " + c.UserDefinedCategorySid);
Console.WriteLine("UserDefinedCategoryName: " + c.UserDefinedCategoryName);
Console.WriteLine("UserDefinedCategoryClassificationSid: " + c.UserDefinedCategoryClassificationSid);
Console.WriteLine("UserDefinedCategoryClassificationName: " + c.UserDefinedCategoryClassificationName);
Console.WriteLine("UserDefinedCategoryClassificationDescription: " + c.UserDefinedCategoryClassificationDescription);
}
}
}
}

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

CompanyManagementServiceClient Class
CompanyManagementServiceClient Members