Skip to main content

What it does

Gets information about batch types within a project which are available to the user with a given role.

Definition

BatchTypeIdentity [] GetAllowedBatchTypes( int userId, int roleType, int projectId );

Parameters

Name

Type

Description

userId

int

User ID

roleType

int

The type of role to be used for the connection. See RoleType for possible values.

projectId

int

The ID of the project for which to get the list of available batch types.

If invalid projectId is passed (less than or equal to zero), the list of available batch types for all projects is returned.

Returned value

TypeDescription
BatchTypeIdentity[]A set of records, each containing information about one of available batch types in the project