Journey Progress HTTP Interface

Please note: Journeys are only available in our Enterprise hosted version of Learning Locker. For more information about the differences, please see this page.

An actor/person’s progress through a journey.

It is accessible through the following HTTP interfaces:

Schema

Name Type Description
_id Mongo ID The id of this journey progress (autogenerated)
organisation Organisation Mongo ID The id of the organisation
createdAt Timestamp When this journey progress was created (autogenerated)
updatedAt Timestamp When this journey progress was last updated (autogenerated)
owner owner The ident associated to this progress
pendingProgress pendingProgress An object of pendingProgress (autogenerated)
completions completions An object of completed statements.
startedAt Timestamp When the first attempt of a waypoint was registered
isCompleted Boolean Has this owner completed this journey?
completedAt Timestamp When was the journey first completed
duration microseconds Time between startedAt and completedAt in microseconds

Owner

This is a reference to the xAPI actor or Learning Locker Persona associated to this progress.

Name Type Description
trackBy string Only "actor" currently supported, "persona" tracking coming soon
ident mixed Either a full xAPI actor object or a Persona Mongo ID

Pending Progress

This is a reference to statements which need processing.

It is an object whose key is the waypointID:

Name Type Decsription
statement Array of Journey Progress Statement The reference to the statement.

Completions

A journey can be completed multiple times if the journey is set to be repeatable. An array of completed journey attempts is stored in this value.

Name Type Description
waypoints object An object of completed waypoints whose key are the waypoint ids.
completedAt Timestamp When this journey attempt was completed.
isCompleted boolean If this journey attempt has been completed.

Completed Waypoint

An array of completed waypoints for a journey attempt

Name Type Description
waypoint Mongo ID The id of the waypoint
order Integer The order of the waypoint
statements Array of journey progress statements A reference to the statements

Journey Progress Statements

Reference and timestamp of a statement.

Name Type Description
statement Mongo ID The id of a statement.
timestamp Timestamp When this statement was added.

Example GET data

{  
  "_id":"59c23b28f6463f3569446bdc",
  "journey":"59c23527bdf9ac67b2ab5ee6",
  "organisation":"59198183d8ea540933227033",
  "updatedAt":"2017-09-20T09:56:04.309Z",
  "createdAt":"2017-09-20T09:55:52.198Z",
  "pendingProgress":{  
    "59c237bebdf9ac67b2ab5ee9":{  
      "statements":[
      ]
    },
    "59c237bebdf9ac67b2ab5eea":{  
      "statements":[  

      ]
    }
  },
  "lockKey":"571bf02f-d41b-4b31-972d-f092845af816",
  "duration":12133,
  "startedAt":"2017-09-20T09:55:50.310Z",
  "completions":[  
    {  
      "waypoints":{  
        "59c237bebdf9ac67b2ab5ee9":{  
          "completedAt":"2017-09-20T09:56:02.443Z",
          "isCompleted":true,
          "statements":[  
            {  
              "timestamp":"2017-09-20T09:56:02.443Z",
              "statement":"59c23b32d138e44d720041a9"
            }
          ],
          "order":1,
          "waypoint":"59c237bebdf9ac67b2ab5ee9"
        },
        "59c237bebdf9ac67b2ab5eea":{  
          "completedAt":"2017-09-20T09:55:53.799Z",
          "isCompleted":true,
          "statements":[  
            {  
              "statement":"59c23b26d138e44a720041ad",
              "timestamp":"2017-09-20T09:55:50.310Z"
            },
            {  
              "timestamp":"2017-09-20T09:55:51.192Z",
              "statement":"59c23b27d138e44a720041ae"
            },
            {  
              "statement":"59c23b28d138e44a720041af",
              "timestamp":"2017-09-20T09:55:52.313Z"
            },
            {  
              "timestamp":"2017-09-20T09:55:52.880Z",
              "statement":"59c23b28d138e44a720041b0"
            },
            {  
              "statement":"59c23b29d138e44a720041b1",
              "timestamp":"2017-09-20T09:55:53.799Z"
            }
          ],
          "order":0,
          "waypoint":"59c237bebdf9ac67b2ab5eea"
        }
      },
      "completedAt":"2017-09-20T09:56:02.443Z",
      "isCompleted":true
    }
  ]
}