User Tools

Site Tools


api2:adaptive:objectives

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

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

An Objective is a set of Knowledge Node which all have a threshold of comprehension. An Objective can be reached when, for each its Knowledge Nodes, the student’s mastery is above the threshold.\\ As the name suggests, the objective only includes the concepts you want the learner to know: we take in charge to analyze the gap between his/her current knolwedge and the knowledge required to understand the concepts included in the objective. To do this, we use the knolwedge structure among other things.\\ ===Object resources=== ^ Property ^ Type ^ Description ^ | name | String | Custom data | | objects | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective | ===Create (POST)=== ^ Method | POST | ^ URL | /objectives | ==Parameters (*Requiered parameters)== ^ Property ^ Type ^ Description ^ | name | String | Custom data | | objects* | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective | ==Send the request (JSON input example)== <code> { name: “Maths1”, objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]}, target_only: FALSE } </code> ==Get the response (JSON output example)== <code> { id: 1, name: “Maths1”, target_only: FALSE, objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} } </code> ===Fetch (GET)=== ^ Method | GET| ^ URL | /objectives/{objective_id} | If no objective_id is provided it will fetch all the Objectives for your instance. ==Get the response (JSON output example)== **With ID provided**\\ <code> { id: 1, name: “Maths1”, target_only: FALSE, objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} } </code> **Without ID provided**\\ <code> [ { id: 1, name: “Maths1”, target_only: FALSE objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} }, { id: 2, name: “day2 - English”, target_only: TRUE, objects: {“knowledge_nodes”: [35,36,37]} } ] </code> ===EDIT (PUT)=== ^ Method | PUT | ^ URL | /objectives/{objective_id} | ==Editable parameters== ^ Property ^ Type ^ Description/expected values | | name | String | Custom data | ==Send the request (JSON input example)== <code> { name: “Mathematics1” } </code> ==Get the response (JSON output example)== <code> { id: 1, name: “Mathematics1”, target_only: FALSE, objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} } </code>

api2/adaptive/objectives.1508145005.txt.gz · Last modified: 2017/10/16 11:10 by maries