...
The table below describes the routes that the HTTP interface provides, all of the URLs are relative to http://www.example.org/data/xAPI where http://www.example.org is the URL of your Learning Locker instance. To access this interface, you must additionally supply your Basic Auth details with each request in the Authorization
header. Your Basic Auth details can be found under Settings > Clients. Go to the xAPI HTTP interface documentation to see the rest of the xAPI routes.
Route | Description |
---|---|
Retrieves a fully described activity. | |
Creates or overwrites a profile document. | |
Creates or merges a profile document. | |
Retrieves a single profile document or multiple profile identifiers. | |
Deletes a single profile document. |
<iframe src="https://player.vimeo.com/video/168961913" width="80%" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="padding-left: 15%;"></iframe>
GET /activities
This route allows you to retrieve the full definition of an activity, meaning that the LRS will return all of the languages displays and extensions that have been sent in statements, along with the most up to date moreInfo
and type
property values. This route requires an activityId
URL parameter (an IRI representing the activity). To try this route out, first insert two statements with different activity definitions and then use the route to retrieve the full activity definition. For more information, view the GET /activities route in the xAPI specification.
Insert Different Activity Definitions
To insert two statements with different activity definitions, use the POST /statements route like the request below, which will return a 200 response if the statements are successfully stored.
Code Block |
---|
POST http://www.example.org/data/xAPI/statements Authorization: YOUR_BASIC_AUTH X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 [{ "actor": { "mbox": "mailto:test@example.org" }, "verb": { "id": "http://www.example.org/verb" }, "object": { "id": "http://www.example.org/activity", "definition": { "name": { "en-GB": "GB Activity Name" }, "description": { "en-GB": "GB Activity Description" }, "extensions": { "http://www.example.com/extension/1": "extension_value_1" }, "moreInfo": "http://www.example.org/activity/moreinfo1", "type": "http://www.example.org/activity/type1" } } }, { "actor": { "mbox": "mailto:test@example.org" }, "verb": { "id": "http://www.example.org/verb" }, "object": { "id": "http://www.example.org/activity", "definition": { "name": { "en-US": "US Activity Name" }, "description": { "en-US": "US Activity Description" }, "extensions": { "http://www.example.com/extension/2": "extension_value_2" }, "moreInfo": "http://www.example.org/activity/moreinfo2", "type": "http://www.example.org/activity/type2" } } }] |
Retrieve Full Activity Definition
To retrieve the full activity definition, you can use a request similar to the request below.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 { "id": "http://www.example.org/activity", "definition": { "name": { "en-GB": "GB Activity Name", "en-US": "US Activity Name" }, "description": { "en-GB": "GB Activity Description", "en-US": "US Activity Description" }, "extensions": { "http://www.example.com/extension/1": "extension_value_1", "http://www.example.com/extension/2": "extension_value_2" }, "moreInfo": "http://www.example.org/activity/moreinfo2", "type": "http://www.example.org/activity/type2" } } |
PUT /activities/profile
This route allows you to create a single profile document if it doesn't exist or overwrite an existing profile document if it does exist. The route has 2 required URL parameters, an activityId
(an IRI representing the activity) and a profileId
(a string representing an identifier for the profile). For more information, view the PUT /activities/profile route in the xAPI specification.
PUT Initial Profile
To PUT an initial profile, the request should be something like the request below. Notice that there is an If-None-Match
header in the request below, this is to ensure that a profile document doesn't already exist before the profile document is created. Without the If-None-Match
header there would be a precondition failure thrown and the response would be a 412 for the request below.
...
Code Block |
---|
HTTP/1.1 204 NO CONTENT X-Experience-API-Version: 1.0.3 |
GET Initial PUT Activity ETag
To retrieve the ETag for the initial profile, you need to retrieve the profile via the GET /activities/profile route. The request below demonstrates how to do this.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "7C0791125FAB08C7EB75CC8044CFDCEA56F506958DEEE763E6608608EE76C9EE" Last-Modified: 2017-08-31T15:16:29.709Z { "key_to_remove": "value_to_remove", "key_to_change": "value_before_changed" } |
PUT Overwrite Profile
To PUT a profile for overwriting, the request should be something like the request below. Notice that the ETag from the previous request has been used in the If-Match
header below. Without the If-Match
header containing the correct ETag there would be a precondition failure thrown and the response would be a 412 for the request below. The If-Match
header ensures that concurrent updates only change the existing profile document you expected to change.
...
Code Block |
---|
HTTP/1.1 204 NO CONTENT X-Experience-API-Version: 1.0.3 |
GET Overwritten Profile
To GET the overwritten profile, the request should be something like the request below.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "BBB79685FA17A8450E7307710C8A79FD9C1059A0106E9F9811AF6FD18D0F0EED" Last-Modified: 2017-08-31T15:17:29.709Z { "key_to_change": "value_after_change", "key_to_add": "value_to_add" } |
POST /activities/profile
This route allows you to create a single profile document if it doesn't exist or merge an existing profile document if it does exist. The route allows the same URL parameters as the PUT /activities/profile route. The profile document is merged when the profile document exists, the existing profile document is a JSON encoded object, and the posted profile document is a JSON encoded object. When the two JSON encoded documents are merged, only the top-level properties are merged. The example requests below demonstrate merging profile documents. For more information, view the POST /activities/profile route in the xAPI specification.
POST Initial Profile
To POST an initial profile, the request should be something like the request below. Notice that there is an If-None-Match
header in the request below, this is to ensure that a profile document doesn't already exist before the profile document is created. Without the If-None-Match
header there would be a precondition failure thrown and the response would be a 412 for the request below.
...
Code Block |
---|
HTTP/1.1 204 NO CONTENT X-Experience-API-Version: 1.0.3 |
GET Initial POST Activity ETag
To retrieve the ETag for the initial profile, you need to retrieve the profile via the GET /activities/profile route. The request below demonstrates how to do this.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "7C0791125FAB08C7EB75CC8044CFDCEA56F506958DEEE763E6608608EE76C9EE" Last-Modified: 2017-08-31T15:16:29.709Z { "key_to_keep": "value_to_keep", "key_to_change": "value_before_change" } |
POST Merge Profile
To POST a profile for merging, the request should be something like the request below. Notice that the ETag from the previous request has been used in the If-Match
header below. Without the If-Match
header containing the correct ETag there would be a precondition failure thrown and the response would be a 412 for the request below. The If-Match
header ensures that concurrent updates only change the existing profile document you expected to change.
...
Code Block |
---|
HTTP/1.1 204 NO CONTENT X-Experience-API-Version: 1.0.3 |
GET Merged Profile
To GET the merged profile, the request should be something like the request below.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "BBB79685FA17A8450E7307710C8A79FD9C1059A0106E9F9811AF6FD18D0F0EED" Last-Modified: 2017-08-31T15:17:29.709Z { "key_to_keep": "value_to_keep", "key_to_change": "value_after_change", "key_to_add": "value_to_add" } |
GET /activities/profile
This route allows you to retrieve a single profile document or multiple profile identifiers. If the profileId
URL parameter is set, it will retrieve a single profile document with the profile identifier, otherwise it will retrieve many profile identifiers. For more information, view the GET /activities/profile route in the xAPI specification.
Retrieve Single Activity Document
The route allows the same URL parameters as the PUT /activities/profile route. A request to this route should be similar to the request below.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "7C0791125FAB08C7EB75CC8044CFDCEA56F506958DEEE763E6608608EE76C9EE" Last-Modified: 2017-08-31T15:16:29.709Z { "example_key": "example_value" } |
Retrieve Many Activity Identifiers
The route allows the same URL parameters as the PUT /activities/profile route except for the profileId
parameter and with the addition of the optional since
parameter. The since
URL parameter is an ISO timestamp that ensures only profile identifiers stored since the timestamp (exclusive) are returned. A request to this route should be similar to the request below.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ["example_profile_id"] |
DELETE /activities/profile
This route allows you to delete a single profile document and allows the same URL parameters as the PUT /activities/profile route. For more information, view the DELETE /activities/profile route in the xAPI specification.
GET Activity Profile ETag
To retrieve the ETag for the activity profile, you need to retrieve the profile via the GET /activities/profile route. The request below demonstrates how to do this.
...
Code Block |
---|
HTTP/1.1 200 OK X-Experience-API-Version: 1.0.3 Content-Type: application/json; charset=utf-8 ETag: "BBB79685FA17A8450E7307710C8A79FD9C1059A0106E9F9811AF6FD18D0F0EED" Last-Modified: 2017-08-31T15:17:29.709Z { "example_key": "example_value" } |
Delete Activity Profile
Notice that the ETag from the previous request has been used in the If-Match
header below. Without the If-Match
header containing the correct ETag there would be a precondition failure thrown and the response would be a 412 for the request below. The If-Match
header ensures that concurrent deletes only delete the existing profile document you expected to delete.
...