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.
Once the content’s structure is declared on our API, logical links between Students and Knowledge Nodes are created. We could call that « subscriptions ». But it goes further than that since this link is also the container of all the results, data computations and analysis for the student. A Student is automatically related to all the Knowledge Nodes.\\

{{ :api2:knowledge_structure:kns.jpg?400 | knowledge_node_students }}

===Object resources===
^ Property     ^ Type      ^ Description         ^
| id | Integer | identifier for the database of Domoscio's API |
| knowledge_node_id | Integer | The knowledge node the knowledge node student belongs to |
| knowledge_node_uid | String | Unique identifier for your database of the knowledge node |
| student_id | Integer | The student the knowledge node student belongs to |
| student_id | Integer | Unique identifier for your database of the student |
| active | Boolean | It becomes false when the reviewing has been done to the end |
| score | Float | The estimated level of the student |
| next_review_at | DateTime | The next reviewing date computed by the engine |
| created_at | DateTime | Date of creation of the object |
| updated_at | DateTime | Last time the object has been modified |


===Fetch (GET)===

^ Method | GET |
^ URL | /knowledge_node_students/{knowledge_node_student_id} |

If no knowledge_node_student_id is provided it will fetch all the Knowledge Node Students for your instance. You can choose to filter the output by providing the following parameters:\\
^ Property     ^ Type      ^ Description         ^
| knowledge_node_id | Integer | The knowledge node the knowledge node student belongs to |
| student_id | Integer | The student the knowledge node student belongs to |

==Get the response (JSON output example)==

**With ID provided**\\

<code>
{
    "id": 762,
    "knowledge_node_id": 2717,
    "student_id": 267,
    "created_at": null,
    "updated_at": "2017-09-20T14:35:45.256Z",
    "next_review_at": "2017-09-22T14:35:45.252Z",
    "active": true,
    "score": 0.875,
    "theta": 3,
    "knowledge_node_uid": "fin_bank",
    "student_uid": "bpraly"
}
</code>


**Without ID provided**\\
<code>
[
    {
        "id": 759,
        "knowledge_node_id": 2714,
        "student_id": 267,
        "created_at": "2017-09-15T17:37:45.226Z",
        "updated_at": "2017-11-20T09:53:09.642Z",
        "next_review_at": "2017-11-22T09:53:09.621Z",
        "active": true,
        "score": null,
        "theta": 0,
        "knowledge_node_uid": "fin_asset",
        "student_uid": "bpraly"
    },
    {
        "id": 762,
        "knowledge_node_id": 2717,
        "student_id": 267,
        "created_at": "2017-09-15T17:37:45.226Z",
        "updated_at": "2017-09-20T14:35:45.256Z",
        "next_review_at": "2017-09-22T14:35:45.252Z",
        "active": true,
        "score": 0.875,
        "theta": 3,
        "knowledge_node_uid": "fin_bank",
        "student_uid": "bpraly"
    }
]
</code>

===Fetch Knowledge Node Students by Student (GET)===

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

User Tools

Site Tools

Page Tools
