getQuizSet

Returns a set of quizzes that match all the specified conditions.

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/getQuizSet?apiKey=API_KEY&accessToken=ACCESS_TOKEN

Paramètres

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

keywords Type : string
The quiz(zes) content must match the specified keywords. Content includes the following data:
  • quiz: title, author and tags
  • questions: title, propositions and answers
  • media: text content of a PDF document, metadata associated to a Youtube video, etc.
quizId Type : string
The quiz identifier must be quizId.
tag Type : string
The quiz(zes) must have the tag tag.
author Type : string
The quiz(zes) must have been written by the user whose firstname and/or lastname specified in author.
player Type : string
The quiz(zes) must have been played in session by the user whose firstname and/or lastname specified in player.
sessionId Type : unsigned integer
The quiz(zes) must have been played in the session with the identifier sessionId.
creationDate Type : datetime
The quiz(zes) must have been created in the time interval specified by creationDate. The parameter value is a comma-separared list of datetimes. If only one datetime d is provided, the time interval is assumed to be [d,d]. Datetimes are of the form "YYYY-MM-DD hh:mm:ss", expressed in UTC (Coordinated Universal Time).
modificationDate Type : datetime
The quiz(zes) must have been modified in the time interval specified by creationDate. The parameter value is a comma-separared list of datetimes. If only one datetime d is provided, the time interval is assumed to be [d,d]. Datetimes are of the form "YYYY-MM-DD hh:mm:ss", expressed in UTC (Coordinated Universal Time).

Réponse

The first DataSetPage of the matching quiz set. The next pages can be obtained by sending getDataSetPage requests with the dataSetId specified in the response :

{
    "dataSetId" : string,
    "itemType" : "quiz",
    "numberOfPages" : unsigned integer,
    "numberOfItemsPerPage" : unsigned integer,
    "totalNumberOfItems" : unsigned integer,
    "items" : Quiz[],
    "currentPageIndex" : unsigned integer        
}

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.

keywords
quizId
tag
author
player
sessionId
creationDate
modificationDate
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.