Source

audrid / API.md

API documentation

Objects:

* tasks
* pools
* exams
* audits
* corrections

Users

  • GET /users
  • POST /users
  • DELETE /pools/<id>

Pools

  • GET /pools
  • GET /pools/<id>
  • POST /pools
  • PUT /pools/<id>
  • DELETE /pools/<id>

... and special methods for subresource tasks:

  • GET /pools/<id>/tasks
  • POST /pools/<id>/tasks
  • PUT /pools/<id>/tasks/<id>
  • DELETE /pools/<id>/tasks/<id>

Exams

  • GET /exams
  • POST /exams
  • DELETE /exams/<id>

Audits

  • GET /audits
  • POST /audits
  • DELETE /audits/<id>

An audit has different stages:

  1. registered
  2. started
  3. finished
  4. corrected

A user has an id, email, first name and last name and belongs to a group. Group membership determine permissions: guest, editor, admin.

Pools and trials are documents. Exams and audits are relations.

Pools and trials are documents, since they contain they are flexible and nested.

Exams and audits are relational.