TRANXACT.AI Help

Student Lifecycle · Academic Structure

Academic Terms

The calendar everything keys off: registration windows, census, grade deadlines.

Type REST10 operationsBase path /api/slcm/termsPublished as /api/v1/terms

Download specification (OpenAPI 3.1) Screen: Academic Terms

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

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

GET/api/slcm/termsList academic terms

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

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

FieldTypeRequiredDescription
codetextYesTerm code — e.g. 2027FA
nametextYesName
academic_yeartextNoAcademic year
term_typetextNoType
start_datedateYesStarts
end_datedateYesEnds
registration_opensdateNoRegistration opens
registration_closesdateNoRegistration closes
add_drop_deadlinedateNoAdd/drop deadline
withdraw_deadlinedateNoWithdrawal deadline
census_datedateNoCensus date — The date enrollment is counted for reporting.
grades_duedateNoGrades due
statustextNoStatus
Allowed: planning open in_progress grading closed
is_currentbooleanNoThis 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

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
codetextYesTerm code — e.g. 2027FA
nametextYesName
academic_yeartextNoAcademic year
term_typetextNoType
start_datedateYesStarts
end_datedateYesEnds
registration_opensdateNoRegistration opens
registration_closesdateNoRegistration closes
add_drop_deadlinedateNoAdd/drop deadline
withdraw_deadlinedateNoWithdrawal deadline
census_datedateNoCensus date — The date enrollment is counted for reporting.
grades_duedateNoGrades due
statustextNoStatus
Allowed: planning open in_progress grading closed
is_currentbooleanNoThis 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

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

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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/terms/{parentId}/refund-bandsRefund bands

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/terms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund-bands" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/slcm/terms/{parentId}/refund-bands/{lineId}Refund bands

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeTerm code — e.g. 2027FA
nametextread, writeName
academic_yeartextread, writeAcademic year
term_typetextread, writeType
start_datedateread, writeStarts
end_datedateread, writeEnds
registration_opensdateread, writeRegistration opens
registration_closesdateread, writeRegistration closes
add_drop_deadlinedateread, writeAdd/drop deadline
withdraw_deadlinedateread, writeWithdrawal deadline
census_datedateread, writeCensus date — The date enrollment is counted for reporting.
grades_duedateread, writeGrades due
statustextread, writeStatus
Allowed: planning open in_progress grading closed
is_currentbooleanread, writeThis is the current term — Only one term is current; setting this clears the others.
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 › Academic Terms 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.