getResults

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

Authentication

Optional authentication : an API access token can be provided in the URL query string to access to restricted data.

Request

Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.

HTTP Request

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

Parameters

Each parameter is URL-encoded and added to the URL query string.

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
    Default value : 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.
    		•

    Response

    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.

    Try it !

    You can test this request on live data and see the API response by filling the form below.

    Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.

    quizSetId
    userSetId
    resultTypes
    aggregationFunctions
    groupBy
    sessionIds
    includeQuizzes
    The button "Execute as authenticated user" is available to connected users only. To connect, click on the "Login" button at the right top of the page.