LearnerProgram

Represents details of a Learning Program Plan that's created for a learner. 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

CatalogYear

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The learner's catalog year, which is the year they began studying at the institution.

ClassCohort

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name for a group of students working through the same program at a similar pace.

Description

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the Learner Program.

EndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date that the learner exited the program.

ExpectedGraduationDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The learner's expected graduation date.

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

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.

LearnerAccountId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The Account associated with the learner that the Learning Program Plan is assigned to.

    This field is a relationship field.

  • Relationship Name: LearnerAccount
  • Relationship Type: Lookup
  • Refers To: Account

LearnerContactId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The Contact record for the learner that the Learning Program Plan is assigned to.

    This field is a relationship field.

  • Relationship Name: LearnerContact
  • Relationship Type: Lookup
  • Refers To: Contact

LearningProgramPlanId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Learning Program Plan that’s associated with the Learner Program.

    This field is a relationship field.

  • Relationship Name: LearningProgramPlan
  • Relationship Type: Lookup
  • Refers To: LearningProgramPlan

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: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of a Learning Program Plan for an individual learner.

OpportunityId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Opportunity associated with the Learner Program.
  • Relationship Name: Opportunity
  • Relationship Type: Lookup
  • Refers To: Opportunity

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

ParentLearnerProgramId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The parent learner program associated with the learner program.
  • Relationship Name: ParentLearnerProgram
  • Relationship Type: Lookup
  • Refers To: LearnerProgram

StartDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date that the learner began the program.

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Nillable, Sort, Update
  • Description: Status of the learner's participation in the program.
  • Possible values:
    • Abandoned
    • Active
    • Completed
    • Not Started
    • Paused

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.

LearnerProgramHistory
History is available for tracked fields of the object.
LearnerProgramOwnerSharingRule
Sharing rules are available for the object.
LearnerProgramShare
Sharing is available for the object.