Skip to main content Skip to navigation

Retrieve small group set allocations

Returns small group set allocations if a valid small group set identifier was provided. When requesting the ID of a small group set that has been deleted, a HTTP 404 Not Found will be returned.

Permission requirements

The user must have Permissions.SmallGroups.Read ("View small groups") on the small group set. By default, roles that have this permission are:

  • Module Auditor
  • Module Assistant
  • Module Manager
  • Departmental Administrator
  • User Access Manager

Information about API permissions



URL substitution variables

:moduleCode The lowercase form of the module code for the module containing the small group set, e.g. ch225
:smallGroupSetId The unique identifier for the small group set

Example request


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"
allocations A mapping from small group ID to allocated student usercodes.

Example response

  "success": true,
  "status": "ok",
"allocations": {
"a0b33a80-6dca-0137-5c82-2860b60c3c19": [
"a4d95440-6dca-0137-5c83-2860b60c3c19": [
} }

Tabula API Methods