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

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

AddedToWaitlist

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the course offering participant is added to the waitlist.

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

CurrencyIsoCode

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The ISO code for the currency related to the course offering participant.
  • Default value: USD
  • Possible values:
    • GBP—British Pound
    • USD—U.S. Dollar

DroppedDateTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the student registered for the course. This field is available in API version 64.0 and later.

EndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the participant's involvement in the course ended.

EnrollmentOfferDeclined

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the course offering participant declines an enrollment offer.

EnrollmentOfferExpiration

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the enrollment offer expires.

IsLocked

  • Type: boolean
  • Properties: Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the record is locked (true) or not (false).
  • Default value: 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).
  • Default value: 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).
  • Default value: 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:
    • 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:
    • Audit
    • Completed
    • Declined Waitlist
    • Dropped
    • Eligible to Enroll from Waitlist
    • Enrolled
    • Expired Waitlist Enrollment Offer
    • Facilitating
    • Failed
    • In Cart
    • On Hold
    • Removed from Waitlist
    • Transfer Credit
    • Waitlist Enrollment Offer in Cart
    • 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. This field is available in API version 64.0 and later.

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.

WaitlistScore

  • Type: int
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The weighted value that determines the position of the course offering participant on the waitlist.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

CourseOfferingParticipantFeed
Feed tracking is available for the object.
CourseOfferingParticipantHistory
History is available for tracked fields of the object.
CourseOfferingParticipantShare
Sharing is available for the object.