Coronavirus (Covid-19): Latest updates and information
Skip to main content Skip to navigation

Update small group set allocations

Allocate students to small groups.

Permission requirements

The user must have Permissions.SmallGroups.Update ("Edit small groups") on the small group set that will be edited. By default, roles that have this permission are:

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

Information about API permissions

Definition

PUT https://tabula.warwick.ac.uk/api/v1/module/:moduleCode/groups/:smallGroupSetId/allocations

The request Content-Type must be set to application/json

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

Request parameters

allocations A mapping from small group ID to a list of usercodes of students allocated to the group. Enrolled students that do not appear in the mapping are deallocated from groups.

Example request

{
  "allocations": {
"a0b33a80-6dca-0137-5c82-2860b60c3c19": [
"xxxxxa",
"xxxxxb",
"xxxxxc"
],
"a4d95440-6dca-0137-5c83-2860b60c3c19": [
"xxxxxd",
"xxxxxe"
]
} }

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 The saved mapping from small group ID to allocated student usercodes.

Example response

{
  "success": true,
  "status": "ok",
"allocations": {
"a0b33a80-6dca-0137-5c82-2860b60c3c19": [
"xxxxxa",
"xxxxxb",
"xxxxxc"
],
"a4d95440-6dca-0137-5c83-2860b60c3c19": [
"xxxxxd",
"xxxxxe"
]
} }

Tabula API Methods