Skip to content

API: Quizes endpoints

/quizes

GET /quizes

List owned and managed Quiz sets.

[] Input:

  • string search: optional search string to filter results
  • integer limit: limit number of results
    • default (in search mode): 16
  • integer page: page number
    • default: 1
    • not used in search mode!

[] Output:

  • list
    • string code: quiz identification string
    • string name: title of the Quiz set

/quiz

GET /quiz

Get/check Quiz set.

[] Input:

  • [!] string quiz: quiz identification string

[] Output:

  • string quiz: quiz identification string
  • string name: title of the Quiz set

POST /quiz

Create a new Quiz set.

[] Input:

  • string language: desired Quiz set language
  • [!] string title: title of the Quiz set
  • string description: optional short description
  • string mode: sets how questions are displayed during the Quiz
    • possible values: TEST / TURNS
      • TEST: all questions are displayed at once, user can answer them in any order and switch between them
      • TURNS: questions are displayed one by one, only one question is visible at a time and the user must answer it before moving to the next question
    • default: TEST
  • string type: type of the Quiz set
    • possible values: set / exam / private
      • set: for practice purposes
      • exam: for exam purposes
      • private: for private purposes (e.g testing)
    • default: set

[] Output:

  • string quiz: quiz identification string

DELETE /quiz

Remove/archive Quiz set.

[] Input:

  • [!] string quiz: quiz identification string

/quiz:questions

GET /quiz:questions

List all questions and question groups in a Quiz set.

[] Input:

  • [!] string quiz: Quiz identification string

[] Output:

  • list
    • string id: external unique question identifier (if present)
    • string question: question identification string (if question)
    • string group: question group title (if group)
    • boolean active: active item

POST /quiz:questions

Assign question(s) to a Quiz set, or one of its question group.

[] Input:

  • [!] string quiz: Quiz identification string
  • string group: optional question group title
  • [!] string questions: comma-separated list of question identification strings

DELETE /quiz:questions

Remove question(s) from a Quiz set, or one of its question group.

[] Input:

  • [!] string quiz: Quiz identification string
  • string group: optional question group title
  • [!] string questions: comma-separated list of question identification strings