List all modules in the system.

Permission requirements

The information is public, but the API must be called by an authenticated user.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/module

GET https://tabula.warwick.ac.uk/api/v1/department/:deptCode/modules

Example request

GET https://tabula.warwick.ac.uk/api/v1/module

Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK and the following parameters:

success	Boolean true
status	The string "ok"
modules	An array of module objects

Example response

{
  "success": true,
  "status": "ok",
  "modules": [
    {
      "active": false,
      "adminDepartment": {
        "code": "NR",
        "name": "WMS PG Research"
      },
      "code": "A31P",
      "name": "Medicine"
    },
    {
      "active": false,
      "adminDepartment": {
        "code": "NR",
        "name": "WMS PG Research"
      },
      "code": "A32P",
      "name": "Medicine (MScR)"
    },
    ...
  ]
}