2.0 Objective object

An objective represents either a practice objective or a test objective for a given user. At the review date, an objective has either been met or not met.

There are three types of objectives:

  • One off — The objective should be met at the review date. No further action is required after the review date.
  • Permanent — Starting at the review date, the proficiency should be maintained at or above the pre-set minimum.
  • Test — At the review date, the test associated with the objective should have been completed.

Example

{
  "id" : "Jx2a5ZfJQ1qT1vasyXzYqQ",
  "type" : "ONEOFF",
  "reviewDate" : "2013-07-30T00:00:00Z",
  "minimumProficiency" : 70,
  "fallingMinimumProficiency": 65,
  "drills" : [ {
    "id" : "nI0LvIkMRwa4eJUSUV1XHA",
    "name" : "String instruments",
    "type" : "DRILL"
  }, {
    "id" : "zGR0UA0MSxibHakXxThygg",
    "name" : "Woodwind instruments",
    "type" : "DRILL"
  }, {
    "id" : "vzrX7HxHTZCuu0iqTqmAzA",
    "name" : "Percussion instruments",
    "type" : "DRILL"
  } ],
  "evaluation" : {
    "met" : true,
    "proficiency" : 81,
    "user" : {
      "id" : "CkGyUQ2b5mNHxyCqk2flKg",
      "name" : "John Smith"
    }
  }
}

Fields

Field Type Description
id
required
String

The unique ID of this practice objective.

Example value: Jx2a5ZfJQ1qT1vasyXzYqQ

type
required
String

The objective type. This can be PERMANENT , ONEOFF or TEST.

reviewDate
optional
Timestamp

Either the start date of the review period (in case of a permanent objective) or the final review date (in case of a one off objective).

For objectives defined for a group, it is possible that the review date is configured per user (group member). In that case, the review date is omitted here.

Example value: 2013-07-30T00:00:00Z

minimumProficiency
optional
Integer

The minimum proficiency to be achieved.

fallingMinimumProficiency
optional
Integer

The minimum proficiency to retain after the minimumProficiency has been achieved. This value is lower than or equal to the minimumProficiency.

drills
required
List of 2.0 Drillable objects

A list of drills associated with this objective.

evaluation
optional
2.0 ObjectiveEvaluation object

Whether the objective was met, and what the proficiency was at the review date. Omitted if the evaluation has not yet taken place.