Roles

Owned by Jeremy Bruce (Unlicensed)
Last updated: May 31, 2019 by Terra Yi (Unlicensed)
1 min read
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. 

Resource Properties
Scope Parameterroles
Location/roles
MethodsGET
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeNotes
nameThe name given to the system role.stringtruedefault
descriptionA description of the system role.stringfalsedefault
defaultMonthlyFeeThe default monthly fee for system roles of this type.numbertrueadditional
defaultMonthlyFeeCurrencyCodeThe currency code for the default monthly fee.stringtrueadditional
defaultMonthlyFeeNotesNotes associated with default monthly fee.stringfalseadditional
overrideDiscountPercentThe override discount percent for this system role.numbertrueadditional
hasAuthorityIndicated if the system role has billing authority by default.booleantrueadditional
isHeadsUpEnabledIndicates if the HeadsUp feature is enabled for this system role.booleantrueadditional
menusMainA list of top navigation bar menu items this role has access to (space delimited)stringtruedefaultUse this to enable/disable the corresponding features in your app.
Example: "Home Actions Tasks Contacts" 
menusActionDetailsA list of menu items this role has access to inside an action (space delimited)stringtruedefaultUse this to enable/disable the corresponding features in your app.
Example: "Overview Participants FileNotes" 
rateThe rates resource associated to this system role.stringfalselink
policyThe policy resource associated to this system role.stringfalselinkNot Yet Implemented.


Link Templates
IdentifierResourceLocation Template
roles.raterates/rates/{roles.rate}
roles.policypolicies/policies/{roles.policy}