Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: Role.GetRolesByName

Scoped Name

APIServer.Role.GetRolesByName

Interface

Field Variable ...as Description
RoleName Position Input The name of the role. Can be used to position the start of the list.
RoleSiteKey Position Input Identifies the site the roles are to be fetched for (mandatory/restrict).
Position Control Input Specifies whether the data in the Position variable is used for positioning when fetching the data.
RowsFetched Control Dual The number of fetched records in the output variable FetchedData.
RoleSurrogate FetchedData (64) Output The unique identification of the role.
RoleName FetchedData (64) Output The name of the role.
RoleDescription FetchedData (64) Output A textual description of the role.
RoleComment FetchedData (64) Output Comment field for the role.
RolePriority FetchedData (64) Output Numeric field - indicates the "importance" of the role. Used for situations where a session is authorized by more than one role and a choice between the roles are necessary. The higher the number, the more important the role is.
RoleSiteKey FetchedData (64) Output The site which the role belongs to.
RoleFolderListID FetchedData (64) Output The folder list to be used for sessions authorized by this role.

Description

Retrieves a list of the roles that has been defined for a site. The roles are retrieved in role name order.

Events

Universal events