Newer Version Available

This content describes an older version of this product. View Latest

CourseOfferingParticipant

Represents information about a student's enrollment in a Course Offering. 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
AcademicTermEnrollmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Academic Term associated with the Course Offering Participant.
This field is a relationship field.
Relationship Name
AcademicTermEnrollment
Relationship Type
Lookup
Refers To
AcademicTermEnrollment
CourseOfferingId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Course Offering associated with the Course Offering Participant.
This field is a relationship field.
Relationship Name
CourseOffering
Relationship Type
Lookup
Refers To
CourseOffering
DroppedDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the student registered for the course.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the participant's involvement in the course ended.
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.
IsRepeatAttempt
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the participant has previously taken the course (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
ParticipantAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Account associated with the Course Offering Participant.
This field is a relationship field.
Relationship Name
ParticipantAccount
Relationship Type
Lookup
Refers To
Account
ParticipantAffiliation
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Nillable, Sort, Update
Description
The participant's role in the course.
Possible values are:
  • Aide
  • Student
  • Teacher
ParticipantContactId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The Contact record associated with the Course Offering Participant.
This field is a relationship field.
Relationship Name
ParticipantContact
Relationship Type
Lookup
Refers To
Contact
ParticipationStatus
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Nillable, Sort, Update
Description
Specifies the participation status of the participant in the course.
Possible values are:
  • Audit
  • Completed
  • Declined Waitlist
  • Dropped
  • Enrolled
  • Facilitating
  • Failed
  • In Cart
  • On Hold
  • Transfer Credit
  • Waitlisted
  • Withdrew
RegistrationDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the student removed the course from the registration.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the participant's involvement in the course began.
Summary
Type
textarea
Properties
Create, Nillable, Update
Description
The summary associated with the Course Offering Participant.