Student Lifecycle · Rooms & Timetabling
Scheduling Settings
Whether an over-full room warns or is refused, whether student clashes are checked, the teaching day the builder works in, and the exam rules.
/api/slcm/scheduling-settingsPublished as /api/v1/scheduling-settingsDownload specification (OpenAPI 3.1) Screen: Scheduling Settings
Overview
| 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 › Scheduling Settings 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.scheduling_settings · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/scheduling-settingsList scheduling settings
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",
"capacity_mode": "warn",
"capacity_basis": "section_capacity",
"student_clash_mode": "off",
"teaching_days": [],
"day_starts": "text",
"day_ends": "text",
"slot_minutes": 10,
"builder_time_limit_ms": 10,
"max_exams_per_day": 10,
"exam_gap_minutes": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/scheduling-settings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/scheduling-settings/{id}Read one scheduling settings
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",
"capacity_mode": "warn",
"capacity_basis": "section_capacity",
"student_clash_mode": "off",
"teaching_days": [],
"day_starts": "text",
"day_ends": "text",
"slot_minutes": 10,
"builder_time_limit_ms": 10,
"max_exams_per_day": 10,
"exam_gap_minutes": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/scheduling-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/scheduling-settingsCreate a scheduling settings
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
capacity_mode | text | No | An over-full room Allowed: warn refuse |
capacity_basis | text | No | Seats needed are Allowed: section_capacity registered |
student_clash_mode | text | No | Students in two sections at once Allowed: off warn refuse |
teaching_days | _text | No | Teaching days |
day_starts | time without time zone | No | Teaching day starts |
day_ends | time without time zone | No | Teaching day ends |
slot_minutes | integer | No | Start times every (minutes) |
builder_time_limit_ms | integer | No | Builder time limit (ms) |
max_exams_per_day | integer | No | Most exams a student sits in a day |
exam_gap_minutes | integer | No | Gap between exams (minutes) |
Sample body
{
"capacity_mode": "warn",
"capacity_basis": "section_capacity",
"student_clash_mode": "off",
"teaching_days": []
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_mode": "warn",
"capacity_basis": "section_capacity",
"student_clash_mode": "off",
"teaching_days": [],
"day_starts": "text",
"day_ends": "text",
"slot_minutes": 10,
"builder_time_limit_ms": 10,
"max_exams_per_day": 10,
"exam_gap_minutes": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/scheduling-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"capacity_mode":"warn","capacity_basis":"section_capacity","student_clash_mode":"off","teaching_days":[]}'PUT/api/slcm/scheduling-settings/{id}Change a scheduling settings
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 |
|---|---|---|---|
capacity_mode | text | No | An over-full room Allowed: warn refuse |
capacity_basis | text | No | Seats needed are Allowed: section_capacity registered |
student_clash_mode | text | No | Students in two sections at once Allowed: off warn refuse |
teaching_days | _text | No | Teaching days |
day_starts | time without time zone | No | Teaching day starts |
day_ends | time without time zone | No | Teaching day ends |
slot_minutes | integer | No | Start times every (minutes) |
builder_time_limit_ms | integer | No | Builder time limit (ms) |
max_exams_per_day | integer | No | Most exams a student sits in a day |
exam_gap_minutes | integer | No | Gap between exams (minutes) |
Sample body
{
"capacity_mode": "warn",
"capacity_basis": "section_capacity"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"capacity_mode": "warn",
"capacity_basis": "section_capacity",
"student_clash_mode": "off",
"teaching_days": [],
"day_starts": "text",
"day_ends": "text",
"slot_minutes": 10,
"builder_time_limit_ms": 10,
"max_exams_per_day": 10,
"exam_gap_minutes": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/scheduling-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"capacity_mode":"warn","capacity_basis":"section_capacity"}'DELETE/api/slcm/scheduling-settings/{id}Delete a scheduling settings
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/scheduling-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/scheduling-settings/{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/scheduling-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a scheduling settings, 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 |
capacity_mode | text | read, write | An over-full room Allowed: warn refuse |
capacity_basis | text | read, write | Seats needed are Allowed: section_capacity registered |
student_clash_mode | text | read, write | Students in two sections at once Allowed: off warn refuse |
teaching_days | _text | read, write | Teaching days |
day_starts | time without time zone | read, write | Teaching day starts |
day_ends | time without time zone | read, write | Teaching day ends |
slot_minutes | integer | read, write | Start times every (minutes) |
builder_time_limit_ms | integer | read, write | Builder time limit (ms) |
max_exams_per_day | integer | read, write | Most exams a student sits in a day |
exam_gap_minutes | integer | read, write | Gap between exams (minutes) |
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 › Scheduling Settings 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.