LOEP Callback API

LOEP Callback API

Each application registered in a LOEP instance can specify its own callback URL. If an application specify a callback URL, LOEP will notify such application of different events related to the Learning Objects registered by it (e.g. new evaluations and quality scores). In order for the notifications generated by a LOEP instance to be satisfactorily received by an application, such application should implement a specific API whose base URL should be its callback URL specified in the LOEP instance. This API is termed "LOEP Callback API".

This page contains documentation on the LOEP Callback API. This documentation belongs to the version 1.1 of LOEP.

Authentication

The LOEP Callback API is expected to use HTTP basic authentication (over HTTP or HTTPs).
The requests made by LOEP include in the HTTP Authentication Header the name and the authentication token of the application in LOEP.

API Specification

The endpoint of the LOEP Callback API is the callback URL specified for the application in the LOEP instance.

All data are provided in JSON format. LOEP does not require the application to respond to its notifications with any data.

The API should only offer one method:

Request	Description
PUT /los/:id	The LOEP instance provides new information about the Learning Object whose identifier in the application is :id. All the information about the Learning Object is provided in JSON format in the "lo" param. The different data that can be included for the Learning Object in this param are listed in the section 'Learning Object Data' shown below.

Learning Object Data

The different data that can be specified when registering a Learning Object in LOEP are documented in the page of the LOEP Learning Object API. All these data are provided by LOEP for each Learning Object. Besides, new fields for the Learning Objects are provided by LOEP in the notifications sent thorugh the LOEP Callback API. These new fields are listed in the tables shown below.

Field	Description
id	Identifier of the Learning Object in the LOEP instance.
created_at	Date in which the Learning Object was registered in LOEP.
updated_at	Date in which the Learning Object was last updated in LOEP.

Besides, for each evaluation model with key evKey, the following fields are provided. The corresponding key for each evaluation model can be found at the page Available Evaluation Models in LOEP.

Field	Description
Evaluations with evKey	The total number of evaluations of the Learning Object performed according to the evaluation model evKey.
Completed Evaluations with evKey	The total number of completed evaluations (i.e. of all criteria) of the Learning Object performed according to the evaluation model evKey.
evKey itemN	Score of the N-th item of type "integer" of the evaluation model evKey given to the Learning Object.
evKey ditemN	Score of the N-th item of type "decimal" of the evaluation model evKey given to the Learning Object.
evKey sitemN	An array of values given to the Learning Object for the N-th item of type "string" of the evaluation model evKey.
evKey titemN	An array of values given to the Learning Object for the N-th item of type "text" of the evaluation model evKey.
evKey comments	An array of comments given to the Learning Object for the evaluation model evKey.
Assignments with evKey	The total number of assignments created to evaluate the Learning Object according to the evaluation model evKey.
Completed assignments with evKey	The number of assignments created to evaluate the Learning Object according to the evaluation model evKey that have been completed.
Rejected assignments with evKey	The number of assignments created to evaluate the Learning Object according to the evaluation model evKey that have been rejected.
Pending assignments with evKey	The number of assignments created to evaluate the Learning Object according to the evaluation model evKey that have not been rejected but have not been completed yet.

Besides, for each metric with key mKey, the following fields are provided. The corresponding key for each metric can be found at the page Available Quality Metrics in LOEP.

Field	Description
Metric Score: mName	The score calculated according to the metric mKey for the Learning Object.