55 structure changes including:
5 Breaking changes
11 Additions
40 Modifications
4 Removals
Modified
40
Breaking
GET /api/v1/online-lesson/{id}
- Path went from
/api/v1/online-lessonto/api/v1/online-lesson/{id}(same operationId)Breaking - Response
-
200 response Modified
- application/json content type Added
- 401, 404 responses Added
GET /api/v1/topic/{id}
- Response
-
200 response Modified
- application/json content type Added
- 401, 404 responses Added
GET /api/v1/topic/{id}/lessons
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
- Path
- id path parameter Added
GET /api/v1/unit-instance/{unit}/assignments
- Query
-
level query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/unit-instance/{unit}/assignments/active
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/unit-instance/{unit}/cats
- Query
-
level query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/unit-instance/{unit}/exams
- Query
-
level query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/unit-instance/{unit}/online-lessons
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/unit-instance/{unit}/topics
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
PATCH /api/v1/assignment/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
PATCH /api/v1/assignment/{id}/content/{contentId}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
PATCH /api/v1/exam/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 404 response Added
- Body
- application/json content type Added
PATCH /api/v1/exam/{id}/question/{questionId}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 404 response Added
- Body
- application/json content type Added
PATCH /api/v1/online-lesson/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
- Body
- application/json content type Added
PATCH /api/v1/online-lesson/{id}/remove-material/{material}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
- Path
- material path parameter Added
PATCH /api/v1/topic/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
POST /api/v1/assignment/{id}/add-content
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
POST /api/v1/assignment/{id}/submit
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 404 response Added
POST /api/v1/exam-period
- Response
-
201 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 200 response Added
POST /api/v1/exam/{id}/add-question
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 404 response Added
POST /api/v1/exam/{id}/finish-attempt/{attempt}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
- application/json content type Added
- 404 response Added
POST /api/v1/exam/{id}/new-attempt
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
- application/json content type Added
- 401, 404 responses Added
POST /api/v1/unit-instance/{unit}/{topic}/new-lesson
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
POST /api/v1/unit-instance/{unit}/new-topic
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
POST /api/v1/unit-instance/{unit}/new-online-lesson
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
- Body
- application/json content type Added
POST /api/v1/unit-instance/{unit}/new-exam
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
- Body
- application/json content type Added
POST /api/v1/unit-instance/{unit}/new-cat
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
POST /api/v1/unit-instance/{unit}/new-assignment
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
POST /api/v1/online-lesson/{id}/add-material
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
- Body
- application/json content type Added
DELETE /api/v1/assignment/{id}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
DELETE /api/v1/assignment/{id}/content/{contentId}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
DELETE /api/v1/assignment/{id}/material/{materialId}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
DELETE /api/v1/exam/{id}
- Response
-
200 response Modified
- application/json content type Added
- 401, 403, 404 responses Added
DELETE /api/v1/exam/{id}/question/{questionId}
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
DELETE /api/v1/online-lesson/{id}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
DELETE /api/v1/topic/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
GET /api/v1/assignment/{id}
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/assignment/{id}/submissions
- Response
- 403, 404 responses Added
GET /api/v1/exam/{id}
- Query
-
accessLevel query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 401, 404 responses Added
GET /api/v1/exam/{id}/attempts
- Response
- 403, 404 responses Added
Removed
4
Breaking
DELETE /api/v1/lesson/{id}/remove-material/{material}
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/assignment/{id}/add-material
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/lesson/{id}/add-batch-material
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/lesson/{id}/add-material
- Removing a resource is always breaking unless it was deprecated before Breaking
Added
11
POST /api/v1/file-uploader/upload
POST /api/v1/exam/{id}/grade-all
POST /api/v1/exam/attempt/{attempt}/grade
POST /api/v1/exam-period/{id}/departments/{departmentId}/link
POST /api/v1/cats/{id}/grade-all
POST /api/v1/assignment/{id}/grade-all
POST /api/v1/assignment/submission/{submission}/grade
GET /api/v1/student/{studentId}/materials
GET /api/v1/exam-period/{id}/departments
GET /api/v1/department/{id}/exam-periods
DELETE /api/v1/exam-period/{id}/departments/{departmentId}/unlink
52 structure changes including:
1 Breaking change
33 Additions
19 Modifications
Modified
19
Breaking
DELETE /api/v1/cats/{id}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
DELETE /api/v1/cats/{id}/question/{question}
- Response
-
200 response Modified
- application/json content type Added
- 403, 404 responses Added
- Path
- id path parameter Added
DELETE /api/v1/lesson/{id}/remove-material/{material}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
message, error, statusCode properties Modified
- Properties are no longer required
-
message, error, statusCode properties Modified
-
application/json content type Modified
- 401, 403 responses Added
GET /api/v1/cats/attempt/{attempt}
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/cats/unit/{unit}
- Query
-
level query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/cats/{id}
- Query
-
level query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
GET /api/v1/cats/{id}/attempts/{student}
- Response
-
200 response Modified
- application/json content type Added
- 404 response Added
PATCH /api/v1/cats/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
PATCH /api/v1/cats/{id}/question/{question}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
- Path
- id path parameter Added
POST /api/v1/lesson/{id}/add-material
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
message, error, statusCode properties Modified
- Properties are no longer required
-
message, error, statusCode properties Modified
-
application/json content type Modified
- 401, 403 responses Added
- Body
- multipart/form-data content type Added
POST /api/v1/lesson/{id}/add-batch-material
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
message, error, statusCode properties Modified
- Properties are no longer required
-
message, error, statusCode properties Modified
-
application/json content type Modified
- 401, 403 responses Added
- Body
- multipart/form-data content type Added
POST /api/v1/cats/{unit}
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403 response Added
POST /api/v1/cats/{id}/new-question
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
POST /api/v1/cats/{id}/new-attempt
- Response
-
201 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 404 response Added
POST /api/v1/cats/{id}/finish-attempt/{attempt}
- Response
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
-
201 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 200, 404 responses Added
- Path
- id path parameter Added
POST /api/v1/cats/attempt/{attempt}/grade
- Response
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
-
201 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 200, 404 responses Added
POST /api/v1/assignment/{id}/submit
- Body
- application/json content type Added
- Path
- id path parameter Added
POST /api/v1/assignment/{id}/add-material
- Path went from
/api/v1/assignment/id/add-materialto/api/v1/assignment/{id}/add-material(same operationId)Breaking - Body
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
PATCH /api/v1/cats/{id}/status
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
-
application/json content type Removed
- 403, 404 responses Added
- Body
- application/json content type Added
Added
33
POST /api/v1/student/{studentId}/assessments/{assessmentId}/attempt
POST /api/v1/promotion/cohort
POST /api/v1/exam/{id}/new-attempt
POST /api/v1/exam/{id}/finish-attempt/{attempt}
POST /api/v1/exam-period
POST /api/v1/cats/answer/{answerId}/manual-grade
PATCH /api/v1/exam-period/{id}
DELETE /api/v1/assignment/{id}/material/{materialId}
DELETE /api/v1/exam-period/{id}
GET /api/v1/admin/config/authenticity-threshold
GET /api/v1/assignment/{id}/submissions
GET /api/v1/cats/{id}/attempts
GET /api/v1/exam-period
GET /api/v1/exam-period/scan/active
GET /api/v1/exam-period/{id}
GET /api/v1/exam/{id}/attempts
GET /api/v1/lesson/{id}/materials
GET /api/v1/materials/detail/{materialId}
GET /api/v1/materials/topic/{topicId}
GET /api/v1/materials/unit/{unitOfferingId}
GET /api/v1/materials/unit/{unitOfferingId}/search
GET /api/v1/materials/unit/{unitOfferingId}/type/{filetype}
GET /api/v1/student/{studentId}/assessments
GET /api/v1/student/{studentId}/assessments/statistics
GET /api/v1/student/{studentId}/assignments/{assignmentId}/preview
GET /api/v1/student/{studentId}/assignments/{assignmentId}/questions
GET /api/v1/student/{studentId}/attempts
GET /api/v1/student/{studentId}/attempts/{attemptId}/validate
GET /api/v1/student/{studentId}/cats/{catId}/preview
GET /api/v1/student/{studentId}/cats/{catId}/questions
GET /api/v1/student/{studentId}/exams/{examId}/preview
GET /api/v1/student/{studentId}/exams/{examId}/questions
PATCH /api/v1/admin/config/authenticity-threshold
4 structure changes including:
4 Additions
Added
4
GET /api/v1/student/{studentId}/units/{studentUnitId}
GET /api/v1/student/{studentId}/units/{studentUnitId}/progress
GET /api/v1/student/{studentId}/units/{studentUnitId}/resume
POST /api/v1/student/{studentId}/units/{studentUnitId}/progress
15 structure changes including:
4 Breaking changes
6 Additions
7 Modifications
2 Removals
Modified
7
Breaking
GET /api/v1/student/{studentId}
- Path went from
/api/v1/student/{studentId}/profileto/api/v1/student/{studentId}(same operationId)Breaking - Response
-
200 response Modified
-
application/json content type Modified
- message, success properties Added
-
application/json content type Modified
GET /api/v1/student/{studentId}/enrollments
- Response
-
200 response Modified
-
application/json content type Modified
-
enrollments property Modified
- courseIntake property Modified
- message property Added
-
enrollments property Modified
-
application/json content type Modified
GET /api/v1/student/{studentId}/exams
- Response
-
200 response Modified
-
application/json content type Modified
-
exams property Modified
-
description, startTime, endTime, duration, unitOffering properties Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- releaseDate, dueDate, status, durationMinutes, maxAttempts, unitOfferingId properties Added
-
description, startTime, endTime, duration, unitOffering properties Removed
- message property Added
-
exams property Modified
-
application/json content type Modified
GET /api/v1/student/{studentId}/notifications
- Response
-
200 response Modified
-
application/json content type Modified
- message, success properties Added
-
application/json content type Modified
GET /api/v1/student/{studentId}/results
- Response
-
200 response Modified
-
application/json content type Modified
-
results property Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- message, grades properties Added
-
results property Removed
-
application/json content type Modified
GET /api/v1/student/{studentId}/units/courses
- Path went from
/api/v1/student/{studentId}/unitsto/api/v1/student/{studentId}/units/courses(same operationId)Breaking - Response
-
200 response Modified
-
application/json content type Modified
-
courses property Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- message, units properties Added
-
courses property Removed
-
application/json content type Modified
PUT /api/v1/student/{studentId}/profile
- Response
-
200 response Modified
-
application/json content type Modified
- success property Added
-
application/json content type Modified
Removed
2
Breaking
GET /api/v1/student/{studentId}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/student/{studentId}/units/active
- Removing a resource is always breaking unless it was deprecated before Breaking
Added
6
GET /api/v1/student/{studentId}/assessments/upcoming
GET /api/v1/student/{studentId}/dashboard
GET /api/v1/student/{studentId}/grades
GET /api/v1/student/{studentId}/units
GET /api/v1/student/{studentId}/units/active
GET /api/v1/student/{studentId}/units/current
10 structure changes including:
10 Additions
Added
10
GET /api/v1/lecturer/{lecturerId}/assignments
GET /api/v1/lecturer/{lecturerId}/cats
GET /api/v1/lecturer/{lecturerId}/dashboard
GET /api/v1/lecturer/{lecturerId}/exams
GET /api/v1/lecturer/{lecturerId}/feedback
GET /api/v1/lecturer/{lecturerId}/profile
GET /api/v1/lecturer/{lecturerId}/students
GET /api/v1/lecturer/{lecturerId}/unit-offerings
GET /api/v1/lecturer/{lecturerId}/unit-offerings/{unitOfferingId}/grades
GET /api/v1/lecturer/{lecturerId}/unit-offerings/{unitOfferingId}/stats
9 structure changes including:
9 Additions
Added
9
DELETE /api/v1/unit-offerings/{id}
GET /api/v1/unit-offerings
GET /api/v1/unit-offerings/by-course-intake/{courseIntakeId}
GET /api/v1/unit-offerings/by-lecturer/{lecturerId}
GET /api/v1/unit-offerings/by-semester/{semesterId}
GET /api/v1/unit-offerings/by-unit-version/{unitVersionId}
GET /api/v1/unit-offerings/{id}
PATCH /api/v1/unit-offerings/{id}
POST /api/v1/unit-offerings
5 structure changes including:
1 Breaking change
3 Additions
2 Modifications
Modified
2
Breaking
GET /api/v1/semesters
- Query
- department query parameter Added
PATCH /api/v1/admin/{id}/connect-institution/{institutionId}
- Verb went from
POSTtoPATCH(same operationId)Breaking
Added
3
GET /api/v1/admin/{id}/institutions
PATCH /api/v1/admin/{id}/disconnect-institution/{institutionId}
PATCH /api/v1/unit/connect-to-course
36 structure changes including:
18 Additions
18 Modifications
Modified
18
Breaking
DELETE /api/v1/user/delete
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 403, 404 responses Added
GET /api/v1/auth/logout
- Response
-
200 response Modified
- application/json content type Added
- 401, 500 responses Added
GET /api/v1/debug-sentry
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 500 response Added
GET /api/v1/user/find/{id}
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 404 responses Added
GET /api/v1/user/me
- Response
-
200 response Modified
- application/json content type Added
- 401 response Added
GET /api/v1/users
- Response
-
200 response Modified
- application/json content type Added
- 401, 403 responses Added
GET /api/v1/users/by-role
- Query
-
role query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 403 responses Added
PATCH /api/v1/user/status/{id}
- Query
-
status query parameter Modified
- Query parameter is no longer required
- Response
-
200 response Modified
- application/json content type Added
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 403, 404 responses Added
POST /api/v1/auth/confirm-reset-token
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 404 responses Added
POST /api/v1/auth/login
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 201, 401, 500 responses Added
POST /api/v1/auth/refresh
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401 response Added
POST /api/v1/auth/reset-password
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 404 responses Added
POST /api/v1/auth/send-reset-token
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 404 response Added
POST /api/v1/register
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 500 response Added
POST /api/v1/register/batch/lecturers
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 403 responses Added
POST /api/v1/register/batch/students
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 401, 403 responses Added
POST /api/v1/register/lecturer
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 500 response Added
POST /api/v1/register/student
- Response
-
400 response Modified
-
application/json content type Modified
-
Type is no longer
objectBreaking
- globalErrorResponse property Removed
-
Type is no longer
-
application/json content type Modified
- 500 response Added
Added
18
GET /api/v1/health
GET /api/v1/info
GET /api/v1/status
GET /api/v1/student/{studentId}
GET /api/v1/student/{studentId}/attendance
GET /api/v1/student/{studentId}/enrollments
GET /api/v1/student/{studentId}/exams
GET /api/v1/student/{studentId}/fees
GET /api/v1/student/{studentId}/messages
GET /api/v1/student/{studentId}/notifications
GET /api/v1/student/{studentId}/profile
GET /api/v1/student/{studentId}/results
GET /api/v1/student/{studentId}/timetable
GET /api/v1/student/{studentId}/units
GET /api/v1/student/{studentId}/units/active
GET /api/v1/uptime
GET /api/v1/version
PUT /api/v1/student/{studentId}/profile
7 structure changes including:
7 Additions
Added
7
DELETE /api/v1/user/delete
GET /api/v1/debug-sentry
GET /api/v1/user/find/{id}
GET /api/v1/user/me
PATCH /api/v1/institute/{id}
PATCH /api/v1/user/status/{id}
POST /api/v1/admin/{id}/connect-institution/{institutionId}
41 structure changes including:
20 Breaking changes
21 Additions
20 Removals
Removed
20
Breaking
DELETE /api/v1/unit-instance/{unit}/lesson/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
DELETE /api/v1/unit-instance/{unit}/lesson/{id}/content/{content}
- Removing a resource is always breaking unless it was deprecated before Breaking
DELETE /api/v1/unit-instance/{unit}/remove-online-lesson
- Removing a resource is always breaking unless it was deprecated before Breaking
DELETE /api/v1/unit-instance/{unit}/topic/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/lesson/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/online-lesson/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/online-lessons
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/topic/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/{topic}/lessons
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/lesson/{id}/content/{content}
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/lesson/{id}/remove-material/{material}
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/online-lesson/{id}/remove-material/{material}
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/online-lesson/{id}/update
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/remove-material/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/topic/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/unit-instance/{unit}/add-material
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/unit-instance/{unit}/lesson/{id}/add-content
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/unit-instance/{unit}/lesson/{id}/add-material
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/unit-instance/{unit}/online-lesson/{id}/add-material
- Removing a resource is always breaking unless it was deprecated before Breaking
POST /api/v1/unit-instance/{unit}/update-lesson/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
Added
21
DELETE /api/v1/lesson/{id}
DELETE /api/v1/lesson/{id}/content/{content}
DELETE /api/v1/lesson/{id}/remove-material/{material}
DELETE /api/v1/online-lesson/{id}
DELETE /api/v1/topic/{id}
GET /api/v1/lesson/{id}
GET /api/v1/online-lesson
GET /api/v1/topic/{id}
GET /api/v1/topic/{id}/lessons
GET /api/v1/unit-instance/{unit}/online-lessons
GET /api/v1/units/{id}
GET /api/v1/units/{id}/versions/{version}
PATCH /api/v1/lesson/{id}
PATCH /api/v1/lesson/{id}/content/{content}
PATCH /api/v1/online-lesson/{id}
PATCH /api/v1/online-lesson/{id}/remove-material/{material}
PATCH /api/v1/topic/{id}
POST /api/v1/lesson/{id}/add-batch-material
POST /api/v1/lesson/{id}/add-content
POST /api/v1/lesson/{id}/add-material
POST /api/v1/online-lesson/{id}/add-material
39 structure changes including:
3 Breaking changes
6 Additions
30 Modifications
3 Removals
Modified
30
Breaking
POST /api/v1/units/new
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/register/batch/lecturers
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/register/batch/students
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/register/lecturer
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/register/student
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/student-enrollment
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/add-material
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/lesson/{id}/add-content
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/lesson/{id}/add-material
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/new-assignment
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/new-cat
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/new-exam
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/new-online-lesson
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/new-topic
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/online-lesson/{id}/add-material
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/update-lesson/{id}
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit-instance/{unit}/{topic}/new-lesson
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit/version/{id}/create-instance
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/unit/create-version
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
GET /api/v1/unit-instance/{unit}/exams
- Query
- level query parameter Added
POST /api/v1/assignment/id/add-material
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/assignment/{id}/add-content
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/assignment/{id}/submit
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/cats/attempt/{attempt}/grade
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/cats/{id}/finish-attempt/{attempt}
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/cats/{id}/new-attempt
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/cats/{id}/new-question
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/cats/{unit}
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/courses/new
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
POST /api/v1/register
- Response
-
200 response Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
Removed
3
Breaking
DELETE /api/v1/unit-instance/{unit}/exam/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
GET /api/v1/unit-instance/{unit}/exam/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
PATCH /api/v1/unit-instance/{unit}/exam/{id}
- Removing a resource is always breaking unless it was deprecated before Breaking
Added
6
POST /api/v1/exam/{id}/add-question
PATCH /api/v1/exam/{id}/question/{questionId}
PATCH /api/v1/exam/{id}
GET /api/v1/exam/{id}
DELETE /api/v1/exam/{id}/question/{questionId}
DELETE /api/v1/exam/{id}