Skip to content

API: Exams endpoints

/exams

GET

Info

List owned and managed exams.

Input:

Output:

  • list
    • string code: exam identification string
    • string name: title of the exam
    • boolean active: exam is active

/exam

GET

Info

Get/check exam.

Input:

  • [!] string exam: exam identification string

Output:

  • string exam: exam identification string
  • string name: title of the exam
  • boolean active: exam is active
  • string status: exam status
    • INACTIVE: exam is inactive but will be activated later
    • ACTIVE: exam is active and new tests can be started
    • PAUSED: exam is active but new tests cannot be started
    • REVIEW: exam is active but already entered review period
    • EXPIRED: exam is inactive
  • datetime start: start date and time
  • datetime end: end date and time

/exam:users

GET

Info

List all users on an exam.

Input:

  • [!] string exam: exam identification string

Output:

  • list
    • string code: user identification string
    • string name: name of the examinee

POST

Info

Assign user(s) to an exam.

Input:

  • [!] string exam: exam identification string
  • [!] string users: comma-separated list of user identification strings

DELETE

Info

Remove user(s) from an exam.

Input:

  • [!] string exam: exam identification string
  • [!] string users: comma-separated list of user identification strings

Last update: November 6, 2019