EducationalCharacteristic

Represents a characteristic about a student such as the student's major or student-athlete status. You can use educational characteristics to filter and search for data and customize the student experience. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

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 educational characteristic.
  • Default value: USD
  • Possible values:
    • GBP—British Pound
    • USD—U.S. Dollar

Description

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The description of the educational characteristic.

EducCharacteristicTypeId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The educational characteristic type that's associated with the educational characteristic.

    This field is a relationship field.

  • Relationship Name: EducCharacteristicType
  • Refers To: EducCharacteristicType

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the educational characteristic is active (true) or not (false). An active educational characteristic can be assigned to a student.
  • Default value: false

IsVisibleToStudent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the educational characteristic is searchable in the student portal (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.

Name

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

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The user who is the owner of this record.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

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.

EducationalCharacteristicChangeEvent
Change events are available for the object.
EducationalCharacteristicFeed
Feed tracking is available for the object.
EducationalCharacteristicHistory
History is available for tracked fields of the object.
EducationalCharacteristicShare
Sharing is available for the object.