rbv_api.getRoleById()

Purpose

Returns information about the specified role in JSON format. Throws an exception if roleId evaluates to Super Admin.

Syntax

rbv_api.getRoleById(roleId)

Parameters

roleId

The original ID of the role.

Permissions Required

Full administrative privileges.

Response

The integration code, name, description, ID, and original ID of the role in JSON format.

Return value

A JSON object containing the role integration code, name, description, ID, and original ID.

Example

Gets role information and prints the role name.

var role = rbv_api.getRoleById("roleId"); rbv_api.println(role.name);