TRANXACT.AI Help

Student Lifecycle · Academic Structure

Sections & Scheduling

What is actually offered this term, who teaches it, when it meets and how full it is.

Type REST17 operationsBase path /api/slcm/sectionsPublished as /api/v1/sections

Download specification (OpenAPI 3.1) Screen: Sections & Scheduling

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 › 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.
Tableslcm.sections · 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

17 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/slcm/sectionsList sections & scheduling

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
location_iduuidNoLocation
course_iduuidYesCourse
term_iduuidYesTerm
faculty_iduuidNoTaught by
delivery_modetextNoDelivery mode
capacityintegerNoCapacity
waitlist_capacityintegerNoWaitlist capacity
roomtextNoRoom
statustextNoStatus
Allowed: planned open closed cancelled in_progress completed
cost_center_iduuidNoCost center
syllabustextNoSyllabus
room_iduuidNoRoom — 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

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
location_iduuidNoLocation
course_iduuidYesCourse
term_iduuidYesTerm
faculty_iduuidNoTaught by
delivery_modetextNoDelivery mode
capacityintegerNoCapacity
waitlist_capacityintegerNoWaitlist capacity
roomtextNoRoom
statustextNoStatus
Allowed: planned open closed cancelled in_progress completed
cost_center_iduuidNoCost center
syllabustextNoSyllabus
room_iduuidNoRoom — 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

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/sections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/sections/{id}/post-gradesPost grades

Path parameters

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

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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

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):

room_id, roomId*, meeting_ids

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

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

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

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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
location_iduuidread, writeLocation
section_notextread onlySection no
course_iduuidread, writeCourse
term_iduuidread, writeTerm
faculty_iduuidread, writeTaught by
delivery_modetextread, writeDelivery mode
capacityintegerread, writeCapacity
waitlist_capacityintegerread, writeWaitlist capacity
enrolled_countintegerread onlyEnrolled count
waitlist_countintegerread onlyWaitlist count
roomtextread, writeRoom
statustextread, writeStatus
Allowed: planned open closed cancelled in_progress completed
cost_center_iduuidread, writeCost center
syllabustextread, writeSyllabus
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
room_iduuidread, writeRoom — Choose from Rooms. To put every meeting of the section in a room, with clash checks, use Assign room.
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 › Sections & Scheduling 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.