List all small group sets in Tabula, filtered by academic year.

Permission requirements

The user must have Permissions.Module.ManageSmallGroups ("Manage small groups") globally.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/groups

Request parameters

academicYear Optional	The academic year to view small group sets for, in the format yy/yy - e.g. 13/14. If this is not set, it defaults to the current academic year (i.e. starting on 1st August)
num Optional	The number of small group sets to return, defaults to 100
skip Optional	How many results to skip (for pagination), defaults to 0

Example request

GET https://tabula.warwick.ac.uk/api/v1/groups?academicYear=13%2f14&num=10&skip=3

Response parameters

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 academic year in the format yy/yy - e.g. 13/14
num	The requested number of results (from the request)
skip	The number of results skipped (from the request)
results	How many actual results were returned
total	The total number of small group sets for this academic year (regardless of num or skip)
groups	An array of small group set objects

Example response

{
  "success": true,
  "status": "ok",
  "academicYear": "13/14",
  "num": 10,
  "skip": 3,
  "results": 10,
  "total": 295,
  "groups": [
    {
      "id": "2552f556-6210-4de7-bb8e-01a3180f609e",
      "module": {
        "code": "CS118",
        "name": "Programming for Computer Scientists",
        "adminDepartment": {
          "code": "CS",
          "name": "Computer Science"
        },
      },
      "archived": false,
      "academicYear": "13/14",
      "name": "CS118 Seminars",
      "allocationMethod": "Manual",
      "format": "seminar",
      "defaultMaxGroupSizeEnabled": false,
      "defaultMaxGroupSize": 15,
      "releasedToTutors": true,
      "releasedToStudents": true,
      "emailTutorsOnChange": true,
      "emailStudentsOnChange": true,
      "collectAttendance": true,
      "studentsCanSeeOtherMembers": false,
      "studentMembership": {
        "total": 8,
        "linkedSits": 0,
        "included": 8,
        "excluded": 0,
        "users": [
          {
            "userId": "esunxx",
            "universityId": "1113039"
          },
          {
            "userId": "esudfs",
            "universityId": "1216684"
          },
          ...
        ],
      },
      "sitsLinks": [],
      "groups": [
        {
          "id": "d6d89d06-8133-4e2c-bf1a-18ab7c3d07f8",
          "name": "Group A",
          "students": [
            {
              "userId": "esunxx",
              "universityId": "1125634"
            },
            {
              "userId": "esudfs",
              "universityId": "1113039"
            },
            ...
          ],
          "maxGroupSize": null,
          "events": [
            {
              "id": "8165aae0-7a4b-4222-a5d5-cd24e97f0117",
              "title": "Event with attendance",
              "location": {
                "name": "CS1.04",
                "locationId": 120394
              },
              "weeks": [
                {
                  "minWeek": 1,
                  "maxWeek": 10
                }
              ],
              "startTime": "09:00",
              "endTime": "09:00",
              "tutors": [
                {
                  "userId": "cuseba",
                  "universityId": "0622088"
                },
              ],
              "day": "Friday"
            },
            ...
          ]
        },
        ...
      ]
    }
  ]
}