Student Lifecycle · Academic Structure
Sections & Scheduling
What is actually offered this term, who teaches it, when it meets and how full it is.
/api/slcm/sectionsPublished as /api/v1/sectionsDownload specification (OpenAPI 3.1) Screen: Sections & Scheduling
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 › Sections & Scheduling 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.sections · 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
17 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/sectionsList sections & scheduling
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",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_no": "SEC-000001",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"faculty_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_mode": "text",
"capacity": 10,
"waitlist_capacity": 10,
"enrolled_count": 10,
"waitlist_count": 10,
"room": "text",
"status": "planned"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/sections?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/sections/{id}Read one sections
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",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_no": "SEC-000001",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"faculty_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_mode": "text",
"capacity": 10,
"waitlist_capacity": 10,
"enrolled_count": 10,
"waitlist_count": 10,
"room": "text",
"status": "planned"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/sectionsCreate a sections
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Location |
course_id | uuid | Yes | Course |
term_id | uuid | Yes | Term |
faculty_id | uuid | No | Taught by |
delivery_mode | text | No | Delivery mode |
capacity | integer | No | Capacity |
waitlist_capacity | integer | No | Waitlist capacity |
room | text | No | Room |
status | text | No | Status Allowed: planned open closed cancelled in_progress completed |
cost_center_id | uuid | No | Cost center |
syllabus | text | No | Syllabus |
room_id | uuid | No | Room — Choose from Rooms. To put every meeting of the section in a room, with clash checks, use Assign room. |
Sample body
{
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"faculty_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_mode": "text",
"capacity": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_no": "SEC-000001",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"faculty_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_mode": "text",
"capacity": 10,
"waitlist_capacity": 10,
"enrolled_count": 10,
"waitlist_count": 10,
"room": "text",
"status": "planned"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/sections" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"course_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","term_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","faculty_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","delivery_mode":"text","capacity":10}'PUT/api/slcm/sections/{id}Change a sections
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 |
|---|---|---|---|
location_id | uuid | No | Location |
course_id | uuid | Yes | Course |
term_id | uuid | Yes | Term |
faculty_id | uuid | No | Taught by |
delivery_mode | text | No | Delivery mode |
capacity | integer | No | Capacity |
waitlist_capacity | integer | No | Waitlist capacity |
room | text | No | Room |
status | text | No | Status Allowed: planned open closed cancelled in_progress completed |
cost_center_id | uuid | No | Cost center |
syllabus | text | No | Syllabus |
room_id | uuid | No | Room — Choose from Rooms. To put every meeting of the section in a room, with clash checks, use Assign room. |
Sample body
{
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_no": "SEC-000001",
"course_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"term_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"faculty_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"delivery_mode": "text",
"capacity": 10,
"waitlist_capacity": 10,
"enrolled_count": 10,
"waitlist_count": 10,
"room": "text",
"status": "planned"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"course_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","term_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/slcm/sections/{id}Delete a sections
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/sections/{id}/post-gradesPost grades
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post-grades" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/sections/{parentId}/contentContent
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/content" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/sections/{parentId}/content/{lineId}Content
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/content/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/sections/{parentId}/content/{lineId}Content
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/content/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/sections/{id}/assign-roomAssign room
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):
room_id, roomId*, meeting_idsResponse
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign-room" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"room_id":"value","roomId":"value","meeting_ids":"value"}'POST/api/slcm/sections/{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/sections/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/sections/{parentId}/meetingsMeetings
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/meetings" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/sections/{parentId}/meetingsMeetings
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/meetings" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/sections/{parentId}/meetings/{lineId}Meetings
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/meetings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/sections/{parentId}/meetings/{lineId}Meetings
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/meetings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/sections/{parentId}/contentContent
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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/content" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/sections/{id}/gradebookGradebook
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/slcm/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/gradebook" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a sections, 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 |
location_id | uuid | read, write | Location |
section_no | text | read only | Section no |
course_id | uuid | read, write | Course |
term_id | uuid | read, write | Term |
faculty_id | uuid | read, write | Taught by |
delivery_mode | text | read, write | Delivery mode |
capacity | integer | read, write | Capacity |
waitlist_capacity | integer | read, write | Waitlist capacity |
enrolled_count | integer | read only | Enrolled count |
waitlist_count | integer | read only | Waitlist count |
room | text | read, write | Room |
status | text | read, write | Status Allowed: planned open closed cancelled in_progress completed |
cost_center_id | uuid | read, write | Cost center |
syllabus | text | read, write | Syllabus |
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 |
room_id | uuid | read, write | Room — Choose from Rooms. To put every meeting of the section in a room, with clash checks, use Assign room. |
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 › Sections & Scheduling 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.