LearnerProfile

Represents information about a learner's profile. This object is available in API version 63.0 and later.

Supported Calls

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

Fields

AcademicLevel

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the learner's academic level.
  • Possible values:
    • Adult Education
    • Doctoral
    • Elementary
    • Graduate
    • High School
    • Middle School
    • Post-Baccalaureate Certificate
    • Pre-K/Preschool
    • Professional Education
    • Undergraduate

AcademicStanding

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the learner's academic standing.
  • Possible values:
    • Academic Dismissal
    • Academic Probation
    • Academic Warning
    • Good Standing
    • Honors/Dean's List
    • Reinstatement Status
    • Required Withdrawal

AcademicTermEnrollmentId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Academic Term Enrollment associated with the Learner Profile.

    This field is a relationship field.

  • Relationship Name: AcademicTermEnrollment
  • Refers To: AcademicTermEnrollment

AdmitTerm

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The academic term in which the learner was admitted to the education institute.

College

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the college associated with the Learner Profile.

Concentration

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the specialization subject of the learner.

ContactId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The Contact associated with the Learner Profile.

    This field is a relationship field.

  • Relationship Name: Contact
  • Relationship Type: Master-detail
  • Refers To: Contact (the master object)

ContactProfileId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Contact Profile associated with the Learner Profile.

    This field is a relationship field.

  • Relationship Name: ContactProfile
  • Refers To: ContactProfile

CumulativeGpa

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The cumulative grade point average of the learner.

CurrencyIsoCode

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

Email

  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The email address of the learner.

EnrollmentReason

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the learner's enrollment reason.
  • Possible values:
    • Continuing
    • First Time
    • Re-admit
    • Transfer in

EnrollmentStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the learner's enrollment status for the academic term.
  • Possible values:
    • Active
    • Dropout
    • Expelled
    • Graduated
    • No show
    • Other
    • Transferred
    • Withdrawn

ExpectedGraduationDate

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

Gender

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's gender.

HasParentalFerpa

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether parental FERPA block is applicable on the learner's records (true) or not (false).
  • Default value: false

HasThirdPartyFerpa

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether third-party FERPA block is applicable on the learner's records (true) or not (false).
  • Default value: false

InstructionMode

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the mode of instructions of the learner's classes.

IsAthlete

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is an athlete (true) or not (false).
  • Default value: false

IsCampusResident

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner resides on campus (true) or not (false).
  • Default value: false

IsDeceased

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is deceased (true) or not (false).
  • Default value: false

IsEnrolledInCareerServices

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is enrolled in career services at the institute (true) or not (false).
  • Default value: false

IsEnrolledInDualDegree

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is enrolled in dual degree (true) or not (false).
  • Default value: false

IsFirstGenerationStudent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is a first generation student (true) or not (false).
  • Default value: false

IsInternationalStudent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is an international student (true) or not (false).
  • Default value: false

IsPellGrantEligible

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is eligible for the Pell Grant (true) or not (false).
  • Default value: false

IsTransferStudent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the learner is a transfer student (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.

Major

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's major.

MajorDeclarationTerm

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The academic term in which the learner declared their major.

MatriculationTerm

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The academic term in which the learner enrolled at the institute.

Minor

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's minor.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the Learner Profile.

PrimaryAdvisorId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The User that is the primary advisor associated with the Learner Profile.

    This field is a relationship field.

  • Relationship Name: PrimaryAdvisor
  • Refers To: User

PrimaryAdvisorName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the learner's primary advisor.

Pronouns

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's preferred gender pronouns.
  • Possible values:
    • He/Him
    • He/They
    • Not Listed
    • She/Her
    • She/They
    • They/Them

SecondConcentration

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the second specialization subject of the learner.

SecondMajor

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's second major.

SecondMinor

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the learner's second minor.

SecondaryAdvisorId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The User that is the secondary advisor associated with the Learner Profile.

    This field is a relationship field.

  • Relationship Name: SecondaryAdvisor
  • Refers To: User

SecondaryAdvisorName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the learner's secondary advisor.

StudentIdNumber

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The identifier issued to the learner by the institution.

StudyYearClassification

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the learner's study year classification.
  • Possible values:
    • Freshman
    • Junior
    • Senior
    • Sophomore

TotalUnitsCompleted

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The total number of units completed by the learner.

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.

LearnerProfileHistory
History is available for tracked fields of the object.