getQuizSet

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

Parameters

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

`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).

Response

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        
}

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.

`keywords`
`quizId`
`tag`
`author`
`player`
`sessionId`
`creationDate`
`modificationDate`

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.