Visualisations

Visualisation configuration.

It is accessible through the following HTTP interfaces:

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

Get all the Learning Locker® visualisations.

LearningLocker::visualisations()->get();

Get a single Learning Locker® visualisation by a visualisations's $id.

LearningLocker::visualisation($id)->get();

Delete a single Learning Locker® visualisation with a visualisations's $id.

LearningLocker::visualisation($id)->delete();

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

LearningLocker::visualisation()->create($data);

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

LearningLocker::visualisation($id)->update($data);

Data Structure

Learning Locker® Visualisations Documentation

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

Visualisation Example

[
  "createdAt" => "2017-09-19T13:13:09.312Z",
  "updatedAt" => "2017-09-19T13:22:00.404Z",
  "owner" => "59c1087dfd869741959c5702",
  "axes" => "{}",
  "organisation" => "59c1087dfd869741959c5703",
  "isPublic" => false,
  "previewPeriod" => "LAST_7_DAYS",
  "filters" => [
    "{\"color\":\"#1e8bc3\"}"
  ],
  "chart" => "LINE",
  "stacked" => true,
  "axesoperator" => "uniqueCount",
  "axesvalue" => "{\"optionKey\":\"statements\",\"searchString\":\"Statements\"}",
  "type" => "COUNTER",
  "description" => "Example Visualisation"
]

Visualisation Model

{
  "_id" : "59c1087dfd869741959c5701",
  "createdAt" : "2017-09-19T13:13:09.312Z",
  "updatedAt" : "2017-09-19T13:22:00.404Z",
  "owner" : "59c1087dfd869741959c5702",
  "axes" : "{}",
  "organisation" : "59c1087dfd869741959c5703",
  "isPublic" : false,
  "previewPeriod" : "LAST_7_DAYS",
  "filters" : [
    "{\"color\":\"#1e8bc3\"}"
  ],
  "chart" : "LINE",
  "stacked" : true,
  "axesoperator" : "uniqueCount",
  "axesvalue" : "{\"optionKey\":\"statements\",\"searchString\":\"Statements\"}",
  "type" : "COUNTER",
  "description" : "Example Visualisation"
}