Journey Progress

Learning Locker Enterprise only. Journey progress is not in the open-source Learning Locker, so LaraLocker has no dedicated methods for them. Reach them through LearningLocker::resource() as below.

An actor/person’s progress through a journey.

It is accessible through the following HTTP interfaces:

• REST HTTP Interface via http://www.example.org/api/v2/journeyprogress.

Get all the Learning Locker® journey progress'.

LearningLocker::resource('journeyprogress')->get();

Get a single Learning Locker® journey progress with a journey progress' $id.

LearningLocker::resource('journeyprogress', $id)->get();

Delete a Learning Locker® journey progress with a journey progress' $id.

LearningLocker::resource('journeyprogress', $id)->delete();

Create a single Learning Locker® journey progress with an array of $data.

LearningLocker::resource('journeyprogress')->create($data);

Update a single Learning Locker® journey progress with a journey progress' $id and an array of $data.

LearningLocker::resource('journeyprogress', $id)->update($data);

Data Structure

Learning Locker® [Enterprise] Journey Progress Documentation

You can use an array when updating or creating a Learning Locker® Journey Progress

Journey Progress Example

[
  "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
    ]
  ]
]

Journey Progress Model

{  
  "_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
    }
  ]
}

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