api2:gameplay:progress_compared_to_population
====== Differences ====== This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
api2:gameplay:progress_compared_to_population [2019/05/21 13:18] maries created |
api2:gameplay:progress_compared_to_population [2019/05/22 09:33] (current) maries |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | 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. | + | 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 progress on objective (i.e. the percent of completion of an objective). This comparison must be done on a specific objective. |
| 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 "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. | ||
| Line 6: | Line 6: | ||
| ^ Method | POST | | ^ Method | POST | | ||
| - | ^ URL | /gameplay_utils/mastery_compared_to_population | | + | ^ URL | /gameplay_utils/progress_compared_to_population | |
| ==Parameters (*Required parameters)== | ==Parameters (*Required parameters)== | ||
| ^ Property ^ Type ^ Description ^ | ^ Property ^ Type ^ Description ^ | ||
| - | | student_id or uid | Integer or String | The identifier of the student you want to get the ranking for. | | + | | student_id or uid* | Integer or String | The identifier of the student you want to get the ranking for. | |
| | student_ids or uids | Array of Integers or Strings | The identifiers of the students you want to compare the first with. | | | student_ids or uids | Array of Integers or Strings | The identifiers of the students you want to compare the first with. | | ||
| - | | knowledge_node_ids or uids | array of Integers or Strings | The id of the concepts you want to have the comparison for. | | + | | objective_id or uid* | Integer or String | The id of the objective you want to have the comparison for. | |
| ==Get the response (JSON output example)== | ==Get the response (JSON output example)== | ||
api2/gameplay/progress_compared_to_population.1558437487.txt.gz · Last modified: 2019/05/21 13:18 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
