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:
Connection HTTP Interface via http://www.example.org/api/connection/journeyProgress.
REST HTTP Interface via http://www.example.org/api/v2/journeyProgress.
...
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 | The ident associated to this progress | |
pendingProgress | An object of pendingProgress (autogenerated) | |
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 |
...
Name | Type | Description |
|---|---|---|
trackBy | string | Only |
ident | mixed | Either a full xAPI actor object or a Persona Mongo ID |
PENDING PROGRESS
This is a reference to statements which need processing.
...
Name | Type | Decsription |
|---|---|---|
statement | Array of Journey Progress Statement | The reference to the statement. |
...
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. |
...
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 |
...