Learning Analytics Documentation

Whilst we recommend using Jisc's managed integration, applications call also write data direct to LRW. Note, organisations need to use one method or the other, they cannot be combined.

Creating and Updating Data

Format:

URL UDD 1.3 onwards:

https://jiscudd.learninglocker.net/models/<entity name>

Legacy URL (1.27)

https://jiscv2.learninglocker.net/api/jisc/stable/<entity name>

Headers:

 Authentication: Basic xxxx
Content-Type: Applications/JSON

eg

https://jiscudd.learninglocker.net/models/student

Body:

The body should be the data in JSON format.

eg

example to go here

The entity name follows the the UDD definition as follows:

  • ▪ assessmentInstance
  • ▪ course
  • ▪ courseInstance
  • ▪ institution
  • ▪ module
  • ▪ moduleInstance
  • ▪ moduleVleMap
  • ▪ period
  • ▪ staff
  • ▪ staffCourseInstance
  • ▪ staffModuleInstance
  • ▪ student
  • ▪ studentAssessmentInstance
  • ▪ studentCourseInstance
  • ▪ studentCourseMembership
  • ▪ studentModuleInstance

Extensions

Extensions

To add an extension to a model:

PUT/PATCH /models/course/COURSE_2

{
"extensions": {
"ht2": {
"foo": "bar"
}
}
}

Returns:

{
"COURSE_ID": "COURSE_2",
"SUBJECT": null,
"TITLE": "Test 1",
"COURSE_AIM": null,
"INST_TIER_1": null,
"INST_TIER_2": null,
"INST_TIER_3": null,
"TENANT_ID": null,
"AWARDING_BODY": null,
"DELETED_AT": null,
"CREATED_AT": null,
"UPDATED_AT": "2017-03-23T17:00:17.000Z",
"deleted": false,
"extensions": {
"ht2": {
"foo": "bar"
}
}
}

Additional PATCHs will add to the existing extension set:

PUT/PATCH /models/course/COURSE_2

{
"extensions": {
"unicon": {
"hello": "world"
}
}
}

Returns:

{
"COURSE_ID": "COURSE_2",
"SUBJECT": null,
"TITLE": "Test 1",
"COURSE_AIM": null,
"INST_TIER_1": null,
"INST_TIER_2": null,
"INST_TIER_3": null,
"TENANT_ID": null,
"AWARDING_BODY": null,
"DELETED_AT": null,
"CREATED_AT": null,
"UPDATED_AT": "2017-03-23T17:01:06.000Z",
"deleted": false,
"extensions": {
"ht2": {
"foo": "bar"
},
"unicon": {
"hello": "world"
}
}
}

Extension PATCHs may be combined with other PATCH data, and multiple CONTROLLER's extensions can be updaetd in a single PATCH.

Further docs:

Legacy URL (1.27):

https://jiscv2.learninglocker.net/api/jisc/stable/