Roles Contract Attributes
The following attributes make up the Roles Contract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| protected boolean | Indicates whether the role has protected access to documents. |
| roleAbbr string | Abbreviation of the role name. A few examples are LO, LP, and LD. |
| roleID int | Role ID. Note: A roleID of "-1" equates to the text value of "Others" in Encompass Smart Client. |
| roleName string | Name of the role. A few examples are Loan Officer, Loan Processor, and Lock Desk. |
| personas object | Object that includes details about the Personas assigned to the role. |
| personas.name string | Name of the Persona. |
| personas.id string | Persona ID. |
| userGroups object | Object that includes details about the User Groups assigned to the role. |
| userGroups.groupId | User Group ID. |
| userGroups.groupName string | Name of the User Group. |
