Retrieve a department
Returns a department object if a valid code was provided.
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/department/:departmentCode
URL substitution variables
:departmentCode |
The lowercase form of the department code, e.g. cs |
---|
Example request
GET https://tabula.warwick.ac.uk/api/v1/department/cs
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" |
department |
A department object representing the department, including modules, routes and sub-departments |
Example response
{
"success": true,
"status": "ok",
"department": {
"code": "CS",
"fullName": "Computer Science",
"modules": [
{
"code": "CS.GENERAL",
"name": "Computer Science"
},
{
"code": "CS118",
"name": "Programming for Computer Scientists"
},
{
"code": "CS119",
"name": "The Practice of Writing in Computer Science"
},
...
],
"name": "DCS",
"routes": [
{
"code": "G400",
"degreeType": "Undergraduate",
"name": "Computing Systems"
},
{
"code": "G401",
"degreeType": "Undergraduate",
"name": "Computing Systems (Intercalated Year)"
},
...
],
"shortName": "DCS"
},
}
Tabula API Methods
- Overview
- The Member object
- The StudentCourseDetails object
- The StudentCourseYearDetails object
- The StudentRelationship object
- The Student RelationshipType object
- The ModuleRegistration object
- Retrieve a member
- Retrieve multiple members
- Retrieve a member's relationships
- List relationship agents in dept.
- Search for members