**This is an old revision of the document!** ----
As described by the schema below, in your instance you have several models of alerts. They represent the alert type. Each model of alert has many alerts.\\ {{ :alerts_engine:structure_alerts.png?200 |structure alerts}} ===Features=== ==Alert model== ^ Property ^ Type ^ Description ^ | name | String | Custom data (<255 characters) | | instance_id | Integer | The ID of your instance | | description | String | Description of the type of alert | ==Alert== ^ Property ^ Type ^ Description ^ | instance_id | Integer | The ID of your instance | | alert_model_id | Integer | ID of the alert_model of this alert | | student_id | Integer | ID of the student involved by the alert | | content_id | Integer | ID of the content involved in the trigger of the alert | | content_url | String | url of the content involved in the trigger of the alert | | content_uid |`String | uid of the content involved in the trigger of the alert | | event_id | String | ID of the event involved in the trigger of the alert | | knowledge_node_id | Integer | Knowledge Node, i.e. concept, involved in the trigger of the alert| | assignment_type | String | What is advised to the student to do | | assignment | String | ID of what is advised to the student to do | ===Alert Model=== ==FETCH (GET)== **URL** ^ Method | PUT | ^ URL | /alert_models/{alert_model_id} | **Get the response (JSON output example)**// //With an alert_model_id// // <code> { "id": 3, "name": "Hesitating", "instance_id": 1, "created_at": "2017-08-08T15:24:31.252Z", "updated_at": "2017-08-08T15:25:19.591Z", "description": "Alerts when a student took a long time to complete a content" } </code> //Without an alert_model_id// // <code> [ { "id": 1, "name": "Student Failing", "instance_id": 1, "created_at": "2017-03-24T09:12:15.753Z", "updated_at": "2017-03-24T09:12:15.753Z", "description": "Alerts when a student fails to one or more exercise(s) consecutively" }, { "id": 2, "name": "Tutoring", "instance_id": 1, "created_at": "2017-03-24T09:13:23.257Z", "updated_at": "2017-03-24T09:13:23.257Z", "description": "A succeeding student have been found as a tutor for one student in difficulty" } ] </code>
