Retrieve information about a particular student's attendance at small group events in Tabula, and meeting monitoring points.

Permission requirements

The user must have Permissions.MonitoringPoints.View ("View monitoring points") on the student to get information about meeting monitoring points, and both of Permissions.Profiles.Read.SmallGroups ("View a member's small groups") and Permissions.SmallGroupEvents.ViewRegister ("View attendance at small group events") on the student to get information about attendance at small group events. By default, any student's relationship agent, past or present, departmental administrators and user access managers have all of these permissions.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/member/:universityId/attendance

GET https://tabula.warwick.ac.uk/api/v1/member/:universityId/attendance/:academicYear

URL substitution variables

:universityId	The 7-digit university ID of the member to get the attendance for, e.g. 1234567. You can use the special value me to request the currently authenticated user's information
:academicYear	The academic year to get attendance for, as a 4-digit start year - e.g. for 13/14, use the string 2013. Defaults to the current academic year

Example request

GET https://tabula.warwick.ac.uk/api/v1/member/1234567/attendance

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"
monitoringPoints	An array of monitoring point attendance objects, if the user has permissions to see them, containing the following properties: point - an object containing information about the monitoring point name - the name of the point startWeek - for term-based points, which academic week number the point starts endWeek - for term-based points, which academic week number the point ends term - a textual representation of the term name the point starts in startDate - for date-based points, the start date of the point, in ISO date format endDate - for date-based points, the end date of the point, in ISO date format state - the state of the point (attended, authorised, unauthorised or not-recorded) autoCreated - true if the point was recorded automatically through some other action in Tabula, else false updatedDate - the date that the state was last changed in ISO date-time format updatedBy - the ITS usercode of the user who made the most recent change note absenceType contents updatedDate - the date that the note was last changed in ISO date-time format updatedBy - the ITS usercode of the user who made the most recent change attachment - a file attachment object for an attachment on the note
smallGroups	An array of small group attendance objects, if the user has permissions to see them, containing the following properties: groupSet - a reduced small group set object containing the following properties: id module name format groups group - a reduced small group object containing the following properties: id name attendance - an array of attendance objects for attendance at a particular instance of an event event - a small group event object. weekNumber - the academic week number for this instance of the event state - the state of the attendance (Attended, MissedAuthorised, MissedUnauthorised, NotRecorded, Late or NotExpected) note - a SmallGroupEventAttendanceNote object

Example response

{
  "success": true,
  "status": "ok",
  "monitoringPoints": [
    {
      "point": {
        "name": "Attendance at SMLC induction meeting in Week 1",
        "startWeek": 1,
        "endWeek": 1,
        "term": "Autumn"
      },
      "state": "authorised",
      "autoCreated": false,
      "note": {
        "absenceType": "academic",
        "contents": "student on temporary withdrawal",
        "updatedBy": "u1234567",
        "updatedDate": "2017-01-05T10:43:07Z"
      },
      "updatedBy": "u1234567",
      "updatedDate": "2017-01-05T10:43:33Z"
    },
    {
      "point": {
        "name": "Attendance at SMLC Skills session",
        "startWeek": 3,
        "endWeek": 3,
        "term": "Autumn"
      },
      "state": "authorised",
      "autoCreated": false,
      "updatedBy": "u1234567",
      "updatedDate": "2017-01-05T10:43:33Z"
    },
	...
  ],
  "smallGroups": [
    {
      "groupSet": {
        "id": "406959ae-581f-4449-88d7-b2e5359a82a5",
        "module": {
          "code": "HP104",
          "name": "Images and Representations of the Hispanic World",
          "adminDepartment": {
            "code": "LN-HP-UG",
            "name": "Hispanic Undergraduate"
          }
        },
        "name": "Images and Representations of the Hispanic World LECTURE",
        "format": "seminar"
      },
      "groups": [
        {
          "group": {
            "id": "66553e0d-2032-4948-b926-ca1754ab6777",
            "name": "Group 1"
          },
          "attendance": [
            {
              "event": {
                "id": "4b73539f-edfb-490e-8791-5b5313ef48e8",
                "title": "Images and Representations of the Hispanic World",
                "day": "Tuesday",
                "startTime": "16:00",
                "endTime": "17:00",
                "location": {
                  "locationId": "45270",
                  "name": "R113"
                },
                "tutors": [
                  {
                    "universityId": "1234567",
                    "userId": "u1234567"
                  }
                ]
              },
              "weekNumber": 1,
              "state": "Late"
            },
            {
              "event": {
                "id": "4b73539f-edfb-490e-8791-5b5313ef48e8",
                "title": "Images and Representations of the Hispanic World",
                "day": "Tuesday",
                "endTime": "17:00",
                "startTime": "16:00",
                "location": {
                  "locationId": "45270",
                  "name": "R113"
                },
                "tutors": [
                  {
                    "universityId": "1234567",
                    "userId": "u1234567"
                  }
                ]
              },
              "weekNumber": 2,
              "state": "Late"
            },
            ...
          ]
        },
        ...
      ]
    },
    ...
  ]
}