Skip to main content Skip to navigation

Department monitoring points

Retrieve all students' monitoring points from a department. The response is paginated, each page contains 10 students.

Permission requirements

The user must have Permissions.MonitoringPoints.View ("View monitoring points") on the student to get information about meeting monitoring points. 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/attendance/department/:departmentCode/:academicYear/:page

URL substitution variables

:departmentCode Department code. e.g. cs.
:academicYear The academic year to get attendance for, as a 4-digit start year - e.g. for 23/24, use the string 2023.
:page Page number. e.g. 1

Example request

GET https://tabula.warwick.ac.uk/api/v1/attendance/department/ec/2023/1

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"
totalPages total number of pages
page current page number
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

Example response

{
"totalPages": 219,
"success": true,
"page": 1,
"status": "ok",
"monitoringPoints": [
{
"universityId": "1130589",
"monitoringPoints": [
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-1",
"startWeek": 1,
"endWeek": 1,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-2",
"startWeek": 2,
"endWeek": 2,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-1",
"startDate": "2024-01-17",
"endDate": "2024-01-18"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-3",
"startWeek": 19,
"endWeek": 19,
"term": "Spring"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-3",
"startDate": "2024-02-09",
"endDate": "2024-03-14"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-2",
"startDate": "2024-02-09",
"endDate": "2024-03-15"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-5",
"startDate": "2024-03-07",
"endDate": "2024-05-31"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-4",
"startDate": "2024-03-15",
"endDate": "2024-05-17"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-4",
"startWeek": 26,
"endWeek": 26,
"term": "Easter vacation"
},
"state": "not-recorded"
}
]
},
{
"universityId": "1306131",
"monitoringPoints": [
{
"point": {
"name": "kai-test-2024-01-24-test-point-1",
"startDate": "2024-01-17",
"endDate": "2024-01-18"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-3",
"startDate": "2024-02-09",
"endDate": "2024-03-14"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-2",
"startDate": "2024-02-09",
"endDate": "2024-03-15"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-5",
"startDate": "2024-03-07",
"endDate": "2024-05-31"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-4",
"startDate": "2024-03-15",
"endDate": "2024-05-17"
},
"state": "not-recorded"
}
]
},
{
"universityId": "1363264",
"monitoringPoints": [
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-1",
"startWeek": 1,
"endWeek": 1,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-2",
"startWeek": 2,
"endWeek": 2,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-1",
"startDate": "2024-01-17",
"endDate": "2024-01-18"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-3",
"startWeek": 19,
"endWeek": 19,
"term": "Spring"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-3",
"startDate": "2024-02-09",
"endDate": "2024-03-14"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-2",
"startDate": "2024-02-09",
"endDate": "2024-03-15"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-5",
"startDate": "2024-03-07",
"endDate": "2024-05-31"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-4",
"startDate": "2024-03-15",
"endDate": "2024-05-17"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-4",
"startWeek": 26,
"endWeek": 26,
"term": "Easter vacation"
},
"state": "not-recorded"
}
]
},
{
"universityId": "1430092",
"monitoringPoints": [
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-1",
"startWeek": 1,
"endWeek": 1,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-2",
"startWeek": 2,
"endWeek": 2,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-1",
"startDate": "2024-01-17",
"endDate": "2024-01-18"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-3",
"startWeek": 19,
"endWeek": 19,
"term": "Spring"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-3",
"startDate": "2024-02-09",
"endDate": "2024-03-14"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-2",
"startDate": "2024-02-09",
"endDate": "2024-03-15"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-5",
"startDate": "2024-03-07",
"endDate": "2024-05-31"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-4",
"startDate": "2024-03-15",
"endDate": "2024-05-17"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-4",
"startWeek": 26,
"endWeek": 26,
"term": "Easter vacation"
},
"state": "not-recorded"
}
]
},
{
"universityId": "1564180",
"monitoringPoints": [
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-1",
"startWeek": 1,
"endWeek": 1,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-2",
"startWeek": 2,
"endWeek": 2,
"term": "Autumn"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-3",
"startWeek": 19,
"endWeek": 19,
"term": "Spring"
},
"state": "not-recorded"
},
{
"point": {
"name": "kai-test-2024-01-24-test-point-term-weeks-4",
"startWeek": 26,
"endWeek": 26,
"term": "Easter vacation"
},
"state": "not-recorded"
}
]
},
{
"universityId": "1651567",
"monitoringPoints": []
},
{
"universityId": "1657825",
"monitoringPoints": []
},
{
"universityId": "1663980",
"monitoringPoints": []
},
{
"universityId": "1664636",
"monitoringPoints": []
},
{
"universityId": "1665990",
"monitoringPoints": []
}
]
}

Tabula API Methods