getUserSet

Returns a set of users 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/getUserSet?apiKey=API_KEY&accessToken=ACCESS_TOKEN

Paramètres

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

userId Type : string
The user identifier must be userId.
userGroupSetId Type : string
The user(s) must belong to one of the user group of the set identified by userGroupSetId.
sessionId Type : unsigned integer
The user(s) must have attended to the session identified by sessionId.
raisedHand Type : boolean
The user(s) must have raised his (their) hand during the session identified by sessionId. This parameter is ignored if sessionId is not specified.
quizId Type : string
The user(s) must have answered to the quiz identified by quizId.

Réponse

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

{
    "dataSetId" : string,
    "itemType" : "user",
    "numberOfPages" : unsigned integer,
    "numberOfItemsPerPage" : unsigned integer,
    "totalNumberOfItems" : unsigned integer,
    "items" : User[],
    "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.

userId
userGroupSetId
sessionId
raisedHand
quizId
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.