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.

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.

===Fetch (POST)===

^ Method | POST |
^ URL | /gameplay_utils/progress_compared_to_population |

==Parameters (*Required parameters)==

^ Property     ^ Type      ^ Description         ^
| 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. |
| 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)==

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

Domoscio Docs

User Tools

Site Tools

Page Tools