Skip to main content Skip to navigation

Create a small group set

Create a new small group set for a specific departmental module within the current academic year.

Permission requirements

The user must have Permissions.SmallGroups.Create ("Create small groups") on the module that the small group set will be created under. By default, roles that have this permission are:

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

Information about API permissions



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

URL substitution variables

:moduleCode The lowercase form of the module code for module to create the small group set in, e.g. cs118

Request parameters

name Required A name for the small group set. Name provided should be less than 200 chars
format Optional The small groups format, one of:
  • seminar - Seminar
  • lab - Lab
  • tutorial - Tutorial
  • project - Project group
  • example - Example Class
  • workshop - Workshop
  • lecture - Lecture
  • meeting - Meeting
  • exam - Exam

Will be set to seminar if not provided
allocationMethod Optional The method for allocating students to groups, one of:
  • Manual - Students are manually allocated to groups by an administrator
  • StudentSignUp - Students sign up to an available group
  • Linked - Student membership is linked to allocation from a linked department small group set
  • Random - Students are randomly allocated to groups

Will be set to Manual if not provided
studentsCanSeeTutorName Optional A boolean value, set to trueif students are allowed to see the name of the event tutor(s), false otherwise
Default: false
studentsCanSeeOtherMembers Optional A boolean value, set to true if students are allowed to see the details of students in the same group, false otherwise
Default: false
collectAttendance Optional A boolean value, set to true if attendance is collected at events, false otherwise
Default: true
allowSelfGroupSwitching Optional Required only if allocationMethod is StudentSignUp. A boolean value, set to true if students are allowed to switch groups until sign-up is closed, false otherwise

Example request

  "name": "MySmallGroupSet-01",
  "format": "lab",
  "studentsCanSeeTutorName": "true"

Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 201 Created. The Location header will be the API endpoint of the individual small group set and the JSON metadata of the created small group set, with the following parameters:

success Boolean true
status The string "ok"
academicYear The string in the format yy/yy"15/16"
groupset A small group set object representing the small group set

Example response

  "success": true,
  "status": "ok",
  "academicYear": "15/16",
  "groupSet": {
    "id": "2552f556-6210-4de7-bb8e-01a3180f629e",
    "archived": false,
    "name": "MySmallGroupSet-01",
    "allocationMethod": "StudentSignUp",
    "format": "lab",
    "openForSignups": false,
    "releasedToTutors": false,
    "releasedToStudents": false,
    "collectAttendance": true,
    "studentsCanSeeTutorName": true,
    "studentsCanSeeOtherMembers": false,
    "emailStudentsOnChange": true,
    "emailTutorsOnChange": true,
    "groups": [],  
    "allowSelfGroupSwitching": false,
    "sitsLinks": [
        "moduleCode": "CH155-24",
        "assessmentGroup": "A2",
        "occurrence": "A",
        "sequence": "A05"
        "moduleCode": "CH155-36",
        "assessmentGroup": "A2",
        "occurrence": "A",
        "sequence": "A08"
    "studentMembership": {
      "total": 5,
      "linkedSits": 5,
      "included": 0,
      "excluded": 0,
      "users": [
          "userId": "xxxxxa",
          "universityId": "1111111"
          "userId": "xxxxxb",
          "universityId": "2111111"
          "userId": "xxxxxc",
          "universityId": "3111111"
          "userId": "xxxxxd",
          "universityId": "4111111"
          "userId": "xxxxxe",
          "universityId": "5111111"

Tabula API Methods