Student Lifecycle · Examinations
Exams
Each exam: who sits it, when, in which rooms (a large exam is split across rooms) and who invigilates. A change that gives a student two exams at once, too many in a day, or a room more candidates than exam seats is refused. An exam shows as scheduled only once it has a date, rooms seating every candidate and an invigilator; until then it stays unscheduled.
/api/slcm/examsPublished as /api/v1/examsOverview
| Package | Student Lifecycle |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Student Lifecycle › Exams on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | slcm.exams · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/examsList exams
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exam_no": "EXA-000001",
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assessment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"exam_type": "final",
"duration_minutes": 10,
"needs_room_type": "lecture",
"exam_date": "2026-10-30",
"start_time": "text",
"end_time": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/exams?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/exams/{id}Read one exams
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exam_no": "EXA-000001",
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assessment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"exam_type": "final",
"duration_minutes": 10,
"needs_room_type": "lecture",
"exam_date": "2026-10-30",
"start_time": "text",
"end_time": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/examsCreate a exams
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
period_id | uuid | Yes | Exam period |
section_id | uuid | No | Section — Or choose a course, for one exam sat by all its sections. |
course_id | uuid | No | Course |
assessment_id | uuid | No | Assessment it marks |
title | text | Yes | Title |
exam_type | text | No | Type Allowed: final midterm resit practical oral |
duration_minutes | integer | No | Length (minutes) |
needs_room_type | text | No | Room type Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other |
exam_date | date | No | Date |
start_time | time without time zone | No | From |
end_time | time without time zone | No | To |
keep_fixed | boolean | No | Keep it where it is when scheduling |
notes | text | No | Notes |
Sample body
{
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assessment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exam_type": "final"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exam_no": "EXA-000001",
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assessment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"exam_type": "final",
"duration_minutes": 10,
"needs_room_type": "lecture",
"exam_date": "2026-10-30",
"start_time": "text",
"end_time": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/exams" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"period_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","title":"Example","section_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","course_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","assessment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","exam_type":"final"}'PUT/api/slcm/exams/{id}Change a exams
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
period_id | uuid | Yes | Exam period |
section_id | uuid | No | Section — Or choose a course, for one exam sat by all its sections. |
course_id | uuid | No | Course |
assessment_id | uuid | No | Assessment it marks |
title | text | Yes | Title |
exam_type | text | No | Type Allowed: final midterm resit practical oral |
duration_minutes | integer | No | Length (minutes) |
needs_room_type | text | No | Room type Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other |
exam_date | date | No | Date |
start_time | time without time zone | No | From |
end_time | time without time zone | No | To |
keep_fixed | boolean | No | Keep it where it is when scheduling |
notes | text | No | Notes |
Sample body
{
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exam_no": "EXA-000001",
"period_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assessment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"exam_type": "final",
"duration_minutes": 10,
"needs_room_type": "lecture",
"exam_date": "2026-10-30",
"start_time": "text",
"end_time": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"period_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","title":"Example"}'DELETE/api/slcm/exams/{id}Delete a exams
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/exams/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/slcm/exams/{parentId}/roomsRooms
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rooms" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/exams/{parentId}/roomsRooms
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rooms" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/exams/{parentId}/rooms/{lineId}Rooms
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rooms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/exams/{parentId}/rooms/{lineId}Rooms
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rooms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/exams/{parentId}/invigilatorsInvigilators
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invigilators" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/exams/{parentId}/invigilatorsInvigilators
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invigilators" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/exams/{parentId}/invigilators/{lineId}Invigilators
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invigilators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/exams/{parentId}/invigilators/{lineId}Invigilators
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/exams/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invigilators/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a exams, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
exam_no | text | read only | Exam no |
period_id | uuid | read, write | Exam period |
section_id | uuid | read, write | Section — Or choose a course, for one exam sat by all its sections. |
course_id | uuid | read, write | Course |
assessment_id | uuid | read, write | Assessment it marks |
title | text | read, write | Title |
exam_type | text | read, write | Type Allowed: final midterm resit practical oral |
duration_minutes | integer | read, write | Length (minutes) |
needs_room_type | text | read, write | Room type Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other |
exam_date | date | read, write | Date |
start_time | time without time zone | read, write | From |
end_time | time without time zone | read, write | To |
keep_fixed | boolean | read, write | Keep it where it is when scheduling |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Student Lifecycle › Exams for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.