api2:gameplay:mastery_compared_to_population
====== Differences ====== This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api2:gameplay:mastery_compared_to_population [2019/05/20 16:07] maries created |
api2:gameplay:mastery_compared_to_population [2019/05/22 09:32] (current) maries |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | 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**). | + | This route is used in order to get the ranking of one student compared to the whole or a sub-part of the population based on the mastery. This mastery can be on all the knowledge_nodes or a subset of the knowledge nodes. |
| - | **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 "percent" contains the answer. It represent the percentage of users who have a better mastery than the main user. In other word, it represents the top XX% the main user is in. |
| - | You get a JSON response, where parameter "count" contains the answer. | + | |
| - | ===Fetch (GET)=== | + | ===Fetch (POST)=== |
| - | ^ Method | GET | | + | ^ Method | POST | |
| ^ URL | /gameplay_utils/mastery_compared_to_population | | ^ URL | /gameplay_utils/mastery_compared_to_population | | ||
| Line 12: | Line 11: | ||
| ^ Property ^ Type ^ Description ^ | ^ Property ^ Type ^ Description ^ | ||
| - | | student_id | Integer | The id of the student you want to get the progress for. | | + | | student_id or uid* | Integer or String | The identifier of the student you want to get the ranking for. | |
| - | | student_uid | String | The uid of the student you want to get the progress for. | | + | | student_ids or uids | Array of Integers or Strings | The identifiers of the students you want to compare the first with. | |
| - | | objective_id | Integer | The id of the objective you want to get the progress for. | | + | | knowledge_node_ids or uids | array of Integers or Strings | The id of the concepts you want to have the comparison for. | |
| - | | objective_uid | String | The uid of the objective you want to get the progress for. | | + | |
| ==Get the response (JSON output example)== | ==Get the response (JSON output example)== | ||
| <code> | <code> | ||
| - | {"count":0.8} | + | {"percent": 0.8} |
| </code> | </code> | ||
api2/gameplay/mastery_compared_to_population.1558361268.txt.gz · Last modified: 2019/05/20 16:07 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
