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

Update a small group set

Edit a small group set's properties.

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

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

name Optional 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
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
studentsCanSeeTutorName Optional A boolean value, set to trueif students are allowed to see the name of the event tutor(s), false otherwise
studentsCanSeeOtherMembers Optional A boolean value, set to true if students are allowed to see the details of students in the same group, false otherwise
collectAttendance Optional A boolean value, set to true if attendance is collected at events, false otherwise
allowSelfGroupSwitching Optional 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-tutorial",
  "format": "tutorial"
}

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 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-tutorial",
    "allocationMethod": "StudentSignUp",
    "format": "tutorial",
    "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