User Tools

Site Tools


api2:data:event

**This is an old revision of the document!** ----

A PCRE internal error occured. This might be caused by a faulty plugin

Once all the management layers and knowledge’s structure are declared, you can start registering all your student’s data and retrieve their statistics on our API. Hence, you can declare Event objects and manage them. For instance, if you need to store results, you can declare an Event object with a EventResult type.\\ The only constraint for the consolidation feature is that you must register your Event as EventReview type and the payload should be either “0” or “100”. For the adaptive learning functionality, the more types we have and the more precise is the payload, the more accurate we are doing recommendations.\\ {{ :api2:data:event.jpg?600 | Event}} ===Object resources=== ^ Property ^ Type ^ Description ^ | type | Text | The type of this Event object. “EventResult”, “EventRead” or “EventReview”| | student_id | Integer | Student identifier | | content_id | Integer | The content identifier | | content_uid | String | The content identifier for your database | | return | Boolean | If true, the system computes and sends backs recommendations, otherwise computes and does not send | | generated_at | DateTime | Time at which the event has been done | |payload | Text | The payload of this event indicates the sucess or fail of the student for this event | | standard | String | standard used to declare the payload | ==Note concerning the payload== You can have several types of payloads.\\ - the first one is a classic score between 0 and 100. The standard is then "score", and a payload of 100 indicates success while a payload of 0 indicates a failure. - the second is the xAPI norm. In that case, the standard is "xAPI", and the payload has the following form: <code> IL FAUT ECRIRE QQC ICI </code> ===Create (POST)=== ^ Method | POST | ^ URL | /knowledge_graphs | ==Parameters (*Requiered parameters)== ^ Property ^ Type ^ Description ^ | name | String | Custom data | ==Send the request (JSON input example)== ==Get the response (JSON output example)== ===Fetch (GET)=== ^ Method | GET| ^ URL | /knowledge_graphs | ==Get the response (JSON output example)== **With ID provided**\\ <code> </code> **Without ID provided**\\ <code> </code> ===EDIT (PUT)=== ^ Method | PUT | ^ URL | /knowledge_graphs/{knowledge_graph_id} | ==Editable parameters== ^ Property ^ Type ^ Description/expected values | | | | | ==Send the request (JSON input example)== <code> { name : « No more Corporate Finance » } </code> ==Get the response (JSON output example)== <code> { id: 1, name: « No more Corporate Finance », instance_id: 1 } </code>

api2/data/event.1507909813.txt.gz · Last modified: 2017/10/13 17:50 by maries