api2:data:gameplay
====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
api2:data:gameplay [2018/07/31 11:23] maries |
api2:data:gameplay [2018/08/01 10:35] (current) maries |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| - | ===/get_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**).\\ |
| - | + | [[api2:data:gameplay:get_progress|More information]] | |
| - | 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=== | ===Second route=== | ||
| - | [[api2:data:second_route|Second route]] | + | Description second route.\\ |
| - | Blabla describe first route | + | [[api2:data:gameplay:second_route|More information]] |
api2/data/gameplay.1533029021.txt.gz · Last modified: 2018/07/31 11:23 by maries
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
