ConstituentRole

Contains information about roles associated with the individual. This object is available in API version 57.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
ContextRecordId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The record of the context that's associated with the constituent. This field is a relationship field. Relationship Name ContextRecord Relationship Type Lookup Refers To Learning
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The short description of the constituent's role in the system.
EffectiveEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date from when the constituent role becomes inactive.
EffectiveStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date from when the constituent role becomes active.
IsLocked	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the record is locked (true) or not (false). The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
MayEdit	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the record can be edited (true) or not (false). The default value is `false`.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name for this record.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who owns this record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PersonId	Type reference Properties Create, Filter, Group, Sort, Update Description The individual associated with the constituent role. This field is a polymorphic relationship field. Relationship Name Person Relationship Type Lookup Refers To Account, Contact, Individual
RoleType	Type picklist Properties Create, Filter, Restricted picklist, Group, Sort, Update Description Specifies the type of constituent role. Possible values are: `Alumni` `Applicant` `Donor` `Faculty` `Mentee` `Mentor` `Parent` `Prospect` `Staff` `Student` `Suspect`
Status	Type picklist Properties Create, Filter, Restricted picklist, Group, Sort, Update Description The status of the constituent role. Possible values are: `Active` `Admitted` `Current` `Enrolled` `Former`

Education Cloud Developer Guide

ConstituentRole

Supported Calls

Fields