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

Create a small group

Create a new small group for a small group set.

Permission requirements

The user must have Permissions.SmallGroups.Create ("Create small groups") on the small group set that the small group 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

Definition

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

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

URL substitution variables

:moduleCode The lowercase form of the module code associated with linked small group set e.g. cs118
:smallGroupSetId The unique identifier for the small group set under which the small group will be created

Request parameters

name Required A name for the small group. Name provided should be less than 200 chars
maxGroupSize Optional Maximum group size.
Will be set to 15 if not provided

Example request

{
  "name": "groupA",
  "maxGroupSize": "35"
}

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 and the JSON metadata of the created small group, 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 linked 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": [
      {
        "id": "2552f556-6210-4de7-bb8e-01a3180f611a",
        "name": "groupA",
        "students": [],
        "maxGroupSize": 35,
        "events": []
      }
    ],  
    "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