Monitoring Point Reports (to SITS) by term
Deprecation notice
This API end-point is deprecated as of 1st January 2020 and will be removed at a later date. You should use the end-point for Monitoring point reports (to SITS) by year.
Warning: if you use Tabula to record missed monitoring points, you should not use this API method to report the number of missed points back to SITS. This method is for setting the number of missed points where monitoring points are recorded outside of Tabula; there will be no record within Tabula of the number of missed points.
Creates one or more Monitoring Point Reports for a list of students for a period of time. A Monitoring Point Report is the number of points that a student has missed for a particular term. Creating a report will then upload missed monitoring points to SITS:eVision. This should include the number of unauthorised missed points that a student has had for a particular term, and should only include students who have one or more missed points.
You can only report missed monitoring points for a single reporting period once. Second and subsequent attempts to report missed points for the same period are rejected.
When all missed monitoring points for the current reporting period have been entered and uploaded to SITS, your Head of Department should be asked to sign the Missed Monitoring Report, which can be obtained from the SITS:eVision portal. On this report, all students who have been reported as having missed one or more monitoring report will be listed. Please print this report, obtain the signature of your Head of Department, and return it to the Academic Office contact noted on the report screen. For further guidance please consult the guidance notes.
Once these points are uploaded to SITS you won't be able to change this information via the API or Tabula. If you need to amend the information later, please contact studentrecords at warwick dot ac dot uk.
Permission requirements
The user must have Permissions.MonitoringPoints.Report
("Report monitoring points") on the submitting department. By default, roles that have this permission are:
- Departmental Administrator
- User Access Manager
Information about API permissions
Definition
POST https://tabula.warwick.ac.uk/api/v1/department/:departmentCode/monitoring-point-reports
The request Content-Type
must be set to application/json
URL substitution variables
:departmentCode |
The lowercase form of the department code for the department submitting the report, e.g. ib or ec |
---|
Request parameters
academicYear Required |
The academic year to report points for, in the format yy/yy - e.g. 13/14 |
---|---|
period Required |
The monitoring point period to report for. This must be one of:
|
missedPoints Required |
A JSON object mapping of University ID (as a string) to an integer representing the number of missed points in this period |
Note: For convenience, it's possible to send SPR codes as keys to the missedPoints
object, but the code itself is ignored - only the 7-digit University ID is taken.
Example request
{
"academicYear": "13/14",
"period": "Autumn",
"missedPoints": {
"1400001": 1,
"1400002": 2,
"1400003": 3,
"1400004": 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" |
academicYear |
The academic year in the format yy/yy - e.g. 13/14 |
period |
The monitoring point period to report for. |
missedPoints |
A JSON object mapping of University ID (as a string) to an integer representing the number of missed points in this period |
Example response
{
"success": true,
"status": "ok",
"academicYear": "13/14",
"period": "Autumn",
"missedPoints": {
"1400001": 1,
"1400002": 2,
"1400003": 3,
"1400004": 1
}
}
Tabula API Methods
- Overview
- The Member object
- The StudentCourseDetails object
- The StudentCourseYearDetails object
- The StudentRelationship object
- The Student RelationshipType object
- The ModuleRegistration object
- Retrieve a member
- Retrieve multiple members
- Retrieve a member's relationships
- List relationship agents in dept.
- Search for members