Student Lifecycle · Academic Structure
Academic Terms
The calendar everything keys off: registration windows, census, grade deadlines.
/api/slcm/termsPublished as /api/v1/termsOverview
| 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 › Academic Terms 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.terms · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/termsList academic terms
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",
"code": "COD-000001",
"name": "Example",
"academic_year": "text",
"term_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"registration_opens": "2026-10-30",
"registration_closes": "2026-10-30",
"add_drop_deadline": "2026-10-30",
"withdraw_deadline": "2026-10-30",
"census_date": "2026-10-30",
"grades_due": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/terms?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/terms/{id}Read one terms
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",
"code": "COD-000001",
"name": "Example",
"academic_year": "text",
"term_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"registration_opens": "2026-10-30",
"registration_closes": "2026-10-30",
"add_drop_deadline": "2026-10-30",
"withdraw_deadline": "2026-10-30",
"census_date": "2026-10-30",
"grades_due": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/termsCreate a terms
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Term code — e.g. 2027FA |
name | text | Yes | Name |
academic_year | text | No | Academic year |
term_type | text | No | Type |
start_date | date | Yes | Starts |
end_date | date | Yes | Ends |
registration_opens | date | No | Registration opens |
registration_closes | date | No | Registration closes |
add_drop_deadline | date | No | Add/drop deadline |
withdraw_deadline | date | No | Withdrawal deadline |
census_date | date | No | Census date — The date enrollment is counted for reporting. |
grades_due | date | No | Grades due |
status | text | No | Status Allowed: planning open in_progress grading closed |
is_current | boolean | No | This is the current term — Only one term is current; setting this clears the others. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"academic_year": "text",
"term_type": "text",
"registration_opens": "2026-10-30",
"registration_closes": "2026-10-30"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"academic_year": "text",
"term_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"registration_opens": "2026-10-30",
"registration_closes": "2026-10-30",
"add_drop_deadline": "2026-10-30",
"withdraw_deadline": "2026-10-30",
"census_date": "2026-10-30",
"grades_due": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/terms" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","start_date":"2026-10-30","end_date":"2026-10-30","academic_year":"text","term_type":"text","registration_opens":"2026-10-30","registration_closes":"2026-10-30"}'PUT/api/slcm/terms/{id}Change a terms
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 |
|---|---|---|---|
code | text | Yes | Term code — e.g. 2027FA |
name | text | Yes | Name |
academic_year | text | No | Academic year |
term_type | text | No | Type |
start_date | date | Yes | Starts |
end_date | date | Yes | Ends |
registration_opens | date | No | Registration opens |
registration_closes | date | No | Registration closes |
add_drop_deadline | date | No | Add/drop deadline |
withdraw_deadline | date | No | Withdrawal deadline |
census_date | date | No | Census date — The date enrollment is counted for reporting. |
grades_due | date | No | Grades due |
status | text | No | Status Allowed: planning open in_progress grading closed |
is_current | boolean | No | This is the current term — Only one term is current; setting this clears the others. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"academic_year": "text",
"term_type": "text",
"start_date": "2026-10-30",
"end_date": "2026-10-30",
"registration_opens": "2026-10-30",
"registration_closes": "2026-10-30",
"add_drop_deadline": "2026-10-30",
"withdraw_deadline": "2026-10-30",
"census_date": "2026-10-30",
"grades_due": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/slcm/terms/{id}Delete a terms
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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/terms/{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/terms/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/terms/{parentId}/refund-bandsRefund bands
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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/terms/{parentId}/refund-bandsRefund bands
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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/terms/{parentId}/refund-bands/{lineId}Refund bands
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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/terms/{parentId}/refund-bands/{lineId}Refund bands
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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a terms, 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 |
code | text | read, write | Term code — e.g. 2027FA |
name | text | read, write | Name |
academic_year | text | read, write | Academic year |
term_type | text | read, write | Type |
start_date | date | read, write | Starts |
end_date | date | read, write | Ends |
registration_opens | date | read, write | Registration opens |
registration_closes | date | read, write | Registration closes |
add_drop_deadline | date | read, write | Add/drop deadline |
withdraw_deadline | date | read, write | Withdrawal deadline |
census_date | date | read, write | Census date — The date enrollment is counted for reporting. |
grades_due | date | read, write | Grades due |
status | text | read, write | Status Allowed: planning open in_progress grading closed |
is_current | boolean | read, write | This is the current term — Only one term is current; setting this clears the others. |
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 › Academic Terms 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.