2.1.1 Objective object

Represents a learning objective.

Fields

Field Type Description
id
required		 String The unique ID of the objective.
name
required		 String The objective's name.
icon
optional		 2.1.1 Media object An optional icon for this objective.
type String constant The objective type. Possible values are:

  • ONEOFF – A one-off objective which is only evaluated at the review date and never thereafter.
  • PERMANENT – A permanent objective which is evaluated continuously starting at the review date.
  • TEST – Represents an objective to complete a test before the review date.
reviewDate
optional		 Date The review date of the objective, if a single date is configured for all users.

Example value: 2016-03-12T15:47:31Z
reviewPeriod
optional		 Duration The duration (ISO 8601) of the review period, if one is configured for the objective.

Example value: PT720H
minimumProficiency Integer The minimum proficiency (on a scale from 0 to 100) to be achieved in order to meet this objective.
fallingMinimumProficiency
optional		 Integer The minimum proficiency (on a scale from 0 to 100) to be retained after achieving the objective in order to still be considered as having met this objective.

If there is no falling minimum proficiency given, the value is equal to the regular minumum proficiency.
evaluation 2.1.1 ObjectiveEvaluation object The evaluation of the objective for a particular user.
playables List of 2.1.1 Playable object The playables (drills, courses or test) that this objective pertains to.
estimatedStudyDuration Duration Estimated duration (ISO 8601) to reach the objective.

Example value: PT48H
messageConfig 2.1.1 MessageConfig object Details about the notification configuration of this objective.

 

Last updated on