V3 Contracts

Roles Contract Attributes

The following attributes are contained within the RolesContract object. These attributes are created and managed in Encompass > Settings > Company/User Setup > Roles.

ATTRIBUTESDESCRIPTION
roles
Array[EntityReferenceContract]
Details about the user's role eligibility.


EntityReferenceContractList of eligible roles.
entityId
string
Required. User ID of the specified user. To get the eligible roles for the logged-in user, use the alias me.
entityName
string
RetrieveOnly. Name of the role. A few examples are Loan Officer, Loan Processor, Lock Desk, and Underwriter.
entityType
string
Role.