getResults

Computes the results of a user set on a quiz set.

Authentification

Authentification facultative : un token d'accès à l'API peut être fourni dans la chaîne d'interrogation de l'URL pour obtenir des données à accès restreint.

Requête

Rouge gras : paramètre obligatoire, Orange gras : au moins un paramètre obligatoire, noir : paramètre optionnel.

Requête HTTP

GET https://api.jelevelamain.fr/getResults?apiKey=API_KEY&accessToken=ACCESS_TOKEN

Paramètres

Chaque paramètre est ajouté à la chaîne d'interrogation de l'URL.

quizSetId Type : string
The identifier of a quiz set.
userSetId Type : string
The identifier of a user set.
resultTypes Type : string
A comma-separated list of result types among the following values : "nbGoodAnswers", "goodAnswersPercent" or "percentile". See ComputedResult for details.
aggregationFunctions Type : string
A comma-separated list of result types among the following values : "min", "max" or "average".
groupBy Type : string
Required when one or several aggregation function(s) are specified. Tells how to group results : by "user" or by "quiz".
  • If groupBy is "user", the result set will contain one item by user identifier contained in the specified user set. Each result value is obtained by applying the specified aggregation function(s) on the quizzes contained in the specified quiz set.
  • If groupBy is "quiz", the result set will contain one item by quiz identifier contained in the specified quiz set. Each result value is obtained by applying the specified aggregation function(s) on the users contained in the specified user set.
  • sessionIds Type : unsigned int
    Keep only the results obtained in the sessions which identifiers are specified in sessionIds.
    includeQuizzes Type : string
    Valeur par défaut : answered
    The type of quizzes are included in results. Can take the values "answered" or "all".
  • If includeQuizzes is "answered", only the answered quizzes are included in detailed results, and do not contribute to aggregated results.
  • If includeQuizzes is "all", all quizzes are included the user results : answered and not answered. In detailed results, the result associated to a non-answered quiz is null result. In aggregated results, each non-answered quiz is included as a 0 value.
  • Réponse

    The first DataSetPage of the result set on success :

    {
        "dataSetId" : string,
        "itemType" : "computedResult",
        "numberOfPages" : unsigned integer,
        "numberOfItemsPerPage" : unsigned integer,
        "totalNumberOfItems" : unsigned integer,
        "items" : ComputedResult[],
        "currentPageIndex" : unsigned integer        
    }
    The next pages can be obtained by sending getDataSetPage requests with the dataSetId specified in the response. A JllmAPIException on error, in particular a UnauthorizedOperationException if the requesting user :
    • is not the owner of at least one of the specified data sets;
    • does not have the appropriate permission(s) to get the specified resultType.

    Essayez maintenant !

    Vous pouvez tester cette requête sur des données réelles et voir la réponse de l'API en remplissant le formulaire ci-dessous.

    Rouge gras : paramètre obligatoire, Orange gras : au moins un paramètre obligatoire, noir : paramètre optionnel.

    quizSetId
    userSetId
    resultTypes
    aggregationFunctions
    groupBy
    sessionIds
    includeQuizzes
    Le bouton "Exécuter en tant qu'utilisateur authentifié" n'est disponible que pour les utilisateurs connectés. Pour vous connecter, cliquer sur le bouton "Connexion" en haut à droite de la page.