TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/slcm/scheduling-settingsPublished as /api/v1/scheduling-settings

Download specification (OpenAPI 3.1) Screen: Scheduling Settings

Overview

PackageStudent Lifecycle
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableslcm.scheduling_settings · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
capacity_modetextNoAn over-full room
Allowed: warn refuse
capacity_basistextNoSeats needed are
Allowed: section_capacity registered
student_clash_modetextNoStudents in two sections at once
Allowed: off warn refuse
teaching_days_textNoTeaching days
day_startstime without time zoneNoTeaching day starts
day_endstime without time zoneNoTeaching day ends
slot_minutesintegerNoStart times every (minutes)
builder_time_limit_msintegerNoBuilder time limit (ms)
max_exams_per_dayintegerNoMost exams a student sits in a day
exam_gap_minutesintegerNoGap 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
capacity_modetextNoAn over-full room
Allowed: warn refuse
capacity_basistextNoSeats needed are
Allowed: section_capacity registered
student_clash_modetextNoStudents in two sections at once
Allowed: off warn refuse
teaching_days_textNoTeaching days
day_startstime without time zoneNoTeaching day starts
day_endstime without time zoneNoTeaching day ends
slot_minutesintegerNoStart times every (minutes)
builder_time_limit_msintegerNoBuilder time limit (ms)
max_exams_per_dayintegerNoMost exams a student sits in a day
exam_gap_minutesintegerNoGap 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
capacity_modetextread, writeAn over-full room
Allowed: warn refuse
capacity_basistextread, writeSeats needed are
Allowed: section_capacity registered
student_clash_modetextread, writeStudents in two sections at once
Allowed: off warn refuse
teaching_days_textread, writeTeaching days
day_startstime without time zoneread, writeTeaching day starts
day_endstime without time zoneread, writeTeaching day ends
slot_minutesintegerread, writeStart times every (minutes)
builder_time_limit_msintegerread, writeBuilder time limit (ms)
max_exams_per_dayintegerread, writeMost exams a student sits in a day
exam_gap_minutesintegerread, writeGap between exams (minutes)
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Student Lifecycle › Scheduling Settings for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.