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

Create a small group event

Create a new small group event for a small group.

Permission requirements

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

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

URL substitution variables

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

Request parameters

title Optional A title for the small group event
day Optional The day of the week that the event takes place on Required only if tutor list is not provided
Acceptable values:
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Sat
  • 7 - Sunday

Should be set to 3 if event day is Wednesday
startTime Optional The start time of the event, in the format HH:mm Required only if tutor list is not provided
endTime Optional The end time of the event, in the format HH:mm Required only if tutor list is not provided
weeks Optional Week numbers when event is going to take placeRequired only if tutor list is not provided.
Should be set to [8,9,14] if event is taking place in week 8th, 9th and 14th
tutors Optional List of all tutors associated with the event
locationOptional An object representing the location of the event.

Example request

{
  "title": "Event with attendance",
  "day": "1",
  "startTime": ""09:30",
  "endTime": "11:30",
  "weeks": [8,9,14],
  "tutors": ["esunxx","esudfs"],
  "location": "CS1.04"
}

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 event and the JSON metadata of the created event, 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": [
          {
            "id": "6402c081-14e9-4b65-8ae9-58a03e1bec51",
            "title": "Event with attendance",
            "location": {
              "name": "CS1.04"
            },			
            "weeks": [
              {
                "minWeek"8",
                "maxWeek"9"
              },
              {
                "minWeek"14",
                "maxWeek"14"
              }
            ],
            "startTime": "09:30",
            "endTime": "11:30",
            "tutors": [
              {
                "userId": "esunxx",
                "universityId": "1113039"
              }
              {
                "userId": "esudfs",
                "universityId": "1216684"
              }
            ],
            "day": "Monday"
          }
        ]
      }
    ],  
    "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