api2:adaptive:objective_students
====== Differences ====== This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api2:adaptive:objective_students [2017/10/07 14:52] 127.0.0.1 external edit |
api2:adaptive:objective_students [2018/07/23 10:21] (current) maries |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | An Objective Student is created to assign an Objective to a Student. | ||
| + | |||
| + | ===Object resources=== | ||
| + | ^ Property ^ Type ^ Description ^ | ||
| + | | id | Integer | identifier for the database of Domoscio's API | | ||
| + | | reached | Boolean | Did the student went through the objective successfully? | | ||
| + | | objective_id | Integer | Objective assigned | | ||
| + | | student_id | Integer | Student who is assigned an objective | | ||
| + | | memorize | Integer | 1 if it has to be memorized, 0 otherwise | | ||
| + | | adaptive | Integer | 1 if it has to be learned, 0 otherwise | | ||
| + | | deadline | Timestamp | Does it have to be memorized for a specific deadline? | | ||
| + | | created_at | DateTime | Date of creation of the object | | ||
| + | | updated_at | DateTime | Last time the object has been modified | | ||
| + | | required_score | Float | Score you expect your user to have to validate the objective | | ||
| + | | mastery_percentage | Float | Percentage of question you expect your user to answer correctly to validate the objective | | ||
| + | | knowledge_node_strategy | String | Indicates the strategy used to choose the best knowledge_node | | ||
| + | | content_strategy | String | Indicates the strategy used to choose the best content | | ||
| + | |||
| + | ===Create (POST)=== | ||
| + | |||
| + | ^ Method | POST | | ||
| + | ^ URL | /objective_students | | ||
| + | |||
| + | ==Parameters (*Requiered parameters)== | ||
| + | |||
| + | ^ Property ^ Type ^ Description ^ | ||
| + | | objective_id or objective_uid* | Integer | Objective assigned | | ||
| + | | student_id or student_uid* | Integer | Student who is assigned an objective | | ||
| + | | memorize* | Boolean | TRUE if it has to be memorized, FALSE otherwise | | ||
| + | | adaptive* | Boolean| TRUE if it has to be learned, FALSE otherwise | | ||
| + | | deadline | Timestamp | Does it have to be memorized for a specific deadline? | | ||
| + | | knowledge_node_strategy | string | Please consult us to discuss which strategy best fits your needs - use default if null | | ||
| + | | content_strategy | string | Please consult us to discuss which strategy best fits your needs - use default if null | | ||
| + | | required_score or mastery_percentage* | Float | Learning difficulty of the objective, between 0 and 1 | | ||
| + | |||
| + | ==Send the request (JSON input example)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | "objective_id": 319, | ||
| + | "student_id": 379, | ||
| + | "deadline": "2019-06-25", | ||
| + | "memorize": true, | ||
| + | "adaptive": true, | ||
| + | "required_score": 0.8 | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ==Get the response (JSON output example)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | "id": 293, | ||
| + | "reached": false, | ||
| + | "created_at": "2017-11-27T17:10:26.984Z", | ||
| + | "updated_at": "2017-11-27T17:10:26.984Z", | ||
| + | "objective_id": 319, | ||
| + | "student_id": 379, | ||
| + | "memorize": true, | ||
| + | "deadline": "2019-06-25", | ||
| + | "adaptive": true, | ||
| + | "required_score": 0.8, | ||
| + | "mastery_percentage": null, | ||
| + | "knowledge_node_strategy": null, | ||
| + | "content_strategy": null | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ===Fetch (GET)=== | ||
| + | |||
| + | ^ Method | GET| | ||
| + | ^ URL | /objective_students/{objective_student_id} | | ||
| + | |||
| + | If no objective_student_id is provided it will fetch all the Objective Students for your instance.\\ | ||
| + | If you do not know the objective_student_id, you can add the parameters objective_id and/or student_id, and send the following request: | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | "student_id": 379 | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ==Get the response (JSON output example)== | ||
| + | |||
| + | |||
| + | **With id provided** | ||
| + | <code> | ||
| + | { | ||
| + | "id": 293, | ||
| + | "reached": false, | ||
| + | "created_at": "2017-11-27T17:10:26.984Z", | ||
| + | "updated_at": "2017-11-27T17:10:26.984Z", | ||
| + | "objective_id": 319, | ||
| + | "student_id": 379, | ||
| + | "instance_id": 45, | ||
| + | "memorize": true, | ||
| + | "deadline": "2019-06-25", | ||
| + | "adaptive": true, | ||
| + | "required_score": 0.8, | ||
| + | "mastery_percentage": null, | ||
| + | "knowledge_node_strategy": null, | ||
| + | "content_strategy": null | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | **Without id provided** | ||
| + | |||
| + | <code> | ||
| + | [ | ||
| + | { | ||
| + | "id": 293, | ||
| + | "reached": false, | ||
| + | "created_at": "2017-11-27T17:10:26.984Z", | ||
| + | "updated_at": "2017-11-27T17:10:26.984Z", | ||
| + | "objective_id": 319, | ||
| + | "student_id": 379, | ||
| + | "instance_id": 45, | ||
| + | "memorize": true, | ||
| + | "deadline": "2019-06-25", | ||
| + | "adaptive": true, | ||
| + | "required_score": 0.8, | ||
| + | "mastery_percentage": null, | ||
| + | "knowledge_node_strategy": null, | ||
| + | "content_strategy": null | ||
| + | }, | ||
| + | { | ||
| + | "id": 294, | ||
| + | "reached": false, | ||
| + | "created_at": "2017-11-27T17:11:07.286Z", | ||
| + | "updated_at": "2017-11-27T17:11:07.286Z", | ||
| + | "objective_id": 318, | ||
| + | "student_id": 379, | ||
| + | "instance_id": 45, | ||
| + | "memorize": true, | ||
| + | "deadline": "2019-06-25", | ||
| + | "adaptive": true, | ||
| + | "required_score": null, | ||
| + | "mastery_percentage": 0.6, | ||
| + | "knowledge_node_strategy": null, | ||
| + | "content_strategy": null | ||
| + | } | ||
| + | ] | ||
| + | </code> | ||
| + | |||
| + | |||
| + | ===Fetch Objective Student by Student (GET)=== | ||
| + | |||
| + | ^ Method | GET | | ||
| + | ^ URL | /students/{student_id}/objective_students | | ||
| + | |||
| + | |||
api2/adaptive/objective_students.1507380730.txt.gz · Last modified: 2017/10/07 14:52 by 127.0.0.1
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
