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.

****Work in progress****


===get_progress===
[[api2:data:/get_progress|/get_progress]]

This route is used in order to get the progress of one student for one specific objective (**proportion of validated OKNS out of all OKNS for the student and the objective**). 

**Two parameters are needed**: one describing the **student (id or uid)** and another one describing the **objective (id or uid)**.
You get a JSON response, where parameter "count" contains the answer.

===Fetch (GET)===

^ Method | GET |
^ URL | /gameplay_utils/get_progress |

==Parameters (*Required parameters)==

^ Property     ^ Type      ^ Description         ^
| student_id    | Integer     | The id of the student you want to get the progress for.        |
| student_uid    | String     | The uid of the student you want to get the progress for.        |
| objective_id    | Integer     | The id of the objective you want to get the progress for.        |
| objective_uid    | String     | The uid of the objective you want to get the progress for.        |

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

<code>
{"count":0.8}
</code>

===Second route===
[[api2:data:second_route|Second route]]
Blabla describe first route

Domoscio Docs

User Tools

Site Tools

Page Tools