Search for university IDs/usercodes

Search amongst all members known to Tabula, using a set of flexible filters. Responses include a simple string array of university IDs or usercodes.

Permission requirements

The user must have Permissions.Profiles.ViewSearchResults ("View profile search results") on PermissionsTarget.Global.

Information about API permissions

Definitions

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

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

GET https://tabula.warwick.ac.uk/api/v1/universityIdSearch/:academicYear

GET https://tabula.warwick.ac.uk/api/v1/usercodeSearch/:academicYear

URL substitution variables

:academicYear	The academic year in which to scope the search. If omitted, the current academic year will be used by default.

Request parameters

department Optional	A comma-separated list of department codes to search for members on Example: cs,in. This can also be passed as multiple department parameters, e.g. ?department=cs&department=in
courseTypes Optional	A comma-separated list of course types to filter students by. Valid values are UG, PGT, PGR, Foundation and PreSessional. This is based off the first character of the course code for the current course.
routes Optional	A comma-separated list of route codes to filter students by.
courses Optional	A comma-separated list of course codes to filter students by.
modesOfAttendance Optional	A comma-separated list of modes of attendance to filter students by, e.g. F for full-time, P for part-time, etc.
yearsOfStudy Optional	A comma-separated list of integers representing years of study (i.e. the current course block) to filter students by.
levelCodes Optional	A comma-separated list of level codes to filter students by.
sprStatuses Optional	A comma-separated list of SPR status codes to filter students by, e.g. F for fully enrolled
modules Optional	A comma-separated list of module codes to filter students by, using their current module registrations
hallsOfResidence Optional	A comma-separated list of halls of residence to filter students by
studentsOnly Optional	Boolean determining whether to restrict results to students and exclude staff. This is true by default.

Example request

GET https://tabula.warwick.ac.uk/api/v1/usercodeSearch?department=cs&routes=G502

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"
academicYear	The academic year the search was performed against
usercodes	An array containing usercode strings. Mutually exclusive with universityIds.
universityIds	An array containing university ID strings. Mutually exclusive with usercodes.

Example response

{
  "success":true,
  "status":"ok",
  "academicYear":"19/20",
  "usercodes":[
    "u1603862",
    "u1727992",
    "u1726461",
    "u1720992",
    "u1613931",
    "u1712144",
    "u1706716",
    "u1720363",
    "u1701024",
    "u1705434",
    "u1617165",
    "u1700783",
    "u1604486"
  ]
}