API Documentation

The goal is to provide a RESTful API utilizing HTTP methods as much as possible for basic operations. This page will be updated as the API becomes further defined.

PUT /api/object

Creates a Learning Object and stores it in the LCR.

Request Body:

{
   "title": "<string>", // required
   "description" : "<string>",  //optional,
   "tags" : ["<string1>", "<string2>", ...] // optional
}

Returns:

{
   "id" : "<string>", // the unique identifier for the new object, present only on success
   "error" : "<string>", // the error message, present only if something goes wrong
}

PUT /api/file/{id}

Adds a new file and associates it to an existing Learning Object.

Parameters:

• id - the unique identifier for the Learning Object the file is to be associated with

Request Body: the raw file data

Returns:

{
   "id" : "<string>", // the unique identifier for the new object, present only on success
   "error" : "<string>", // the error message, present only if something goes wrong
}