...
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. |
...
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.
...
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.
...
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.
...
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.
...
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.
...