getUserSet

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

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

Parameters

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

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.

Response

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        
}

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.

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