The information in this document is currently in BETA and subject to change. |
The Roles resource details the various system roles that have been set up in the system. Each User who has access to the system belongs to a system role. Permissions and many other settings are set on a system role basis. The meta data attribute "currentRole" is a link to the Roles resource for the accessing user.
Scope Parameter | roles |
---|---|
Location | /roles |
Methods | GET |
Default Page Size | 50 |
Max Page Size | 200 |
Default Includes | None |
Field | Description | Format | Required | Field Type | Notes |
---|---|---|---|---|---|
name | The name given to the system role. | string | true | default | |
description | A description of the system role. | string | false | default | |
The default monthly fee for system roles of this type. | number | true | additional | ||
The currency code for the default monthly fee. | string | true | additional | ||
Notes associated with default monthly fee. | string | false | additional | ||
The override discount percent for this system role. | number | true | additional | ||
Indicated if the system role has billing authority by default. | boolean | true | additional | ||
Indicates if the HeadsUp feature is enabled for this system role. | boolean | true | additional | ||
menusMain | A list of top navigation bar menu items this role has access to (space delimited) | string | true | default | Use this to enable/disable the corresponding features in your app. Example: "Home Actions Tasks Contacts" |
menusActionDetails | A list of menu items this role has access to inside an action (space delimited) | string | true | default | Use this to enable/disable the corresponding features in your app. Example: "Overview Participants FileNotes" |
rate | The rates resource associated to this system role. | string | false | link | |
The policy resource associated to this system role. | string | false | link | Not Yet Implemented. |
Identifier | Resource | Location Template |
---|---|---|
roles.rate | rates | /rates/{roles.rate} |
roles.policy | policies | /policies/{roles.policy} |