Domoscio Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
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 |

===Create (POST)===

^ Method | POST |
^ URL | /objective_students |

==Parameters (*Requiered parameters)==

^ Property     ^ Type      ^ Description         ^
| objective_id* | Integer | Objective assigned |
| student_id* | 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? |

==Send the request (JSON input example)==

<code>
{
   "objective_id": 319,
   "student_id": 379,
   "deadline": "2019-06-25",
   "memorize": true,
   "adaptive": true
}
</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
}
</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
}
</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
    },
    {
        "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
    }
]
</code>


===Fetch Objective Student by Student (GET)===

^ Method | GET |
^ URL | /students/{student_id}/objective_students |
Domoscio Docs

User Tools

Site Tools

Page Tools
