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

API: Role.GetByName

Scoped Name

APIServer.Role.GetByName

Interface

Field Variable ...as Description
RoleName Input Input The name of the role (mandatory).
RoleSiteKey Input Input The unique identification of the site (mandatory).
RoleSurrogate FetchedData Output The unique identification of the role.
RoleName FetchedData Output The name of the role.
RoleDescription FetchedData Output A textual description of the role.
RoleComment FetchedData Output Comment field for the role.
RolePriority FetchedData 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 Output The site, which the role belongs to.
RoleFolderListID FetchedData Output The folder list to be used for sessions authorized by this role.

Description

Retrieves the information for a role, based on the role name and the site the role belongs to.

Events

Universal events