TRANXACT.AI Help

Student Lifecycle · Students

Student Records

The record itself: program, advisor, standing, credits, GPA and what is blocking progress.

Type REST16 operationsBase path /api/slcm/studentsPublished as /api/v1/students

Download specification (OpenAPI 3.1) Screen: Student Records

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 › Student Records 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.students · 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

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

GET/api/slcm/studentsList student records

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",
      "student_no": "STU-000001",
      "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "first_name": "Example",
      "last_name": "Example",
      "preferred_name": "Example",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "date_of_birth": "2026-10-30",
      "nationality": "text",
      "address": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/slcm/students?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/slcm/students/{id}Read one students

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",
  "student_no": "STU-000001",
  "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "date_of_birth": "2026-10-30",
  "nationality": "text",
  "address": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/slcm/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/studentsCreate a students

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoCampus
user_iduuidNoPortal sign-in — An older console sign-in for the student. Students now use the student portal: the Portal action on this row invites them.
first_nametextYesFirst name
last_nametextYesLast name
preferred_nametextNoPreferred name
emailtextNoEmail
phonetextNoPhone
date_of_birthdateNoDate of birth
nationalitytextNoNationality
addresstextNoAddress
emergency_contacttextNoEmergency contact
program_iduuidNoProgram
advisor_iduuidNoAdvisor
admit_term_iduuidNoAdmit term
expected_graduation_term_iduuidNoExpected graduation
enrollment_statustextNoLoad
Allowed: full_time part_time not_enrolled
statustextNoStatus
academic_standingtextNoAcademic standing
residencytextNoResidency
Allowed: in_state out_of_state international
cohorttextNoCohort
sponsor_account_iduuidNoFees billed to (sponsor) — An employer or scholarship body that pays this student’s fees. Leave blank and the bills are to the student.

Sample body

{
  "first_name": "Example",
  "last_name": "Example",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_name": "Example",
  "email": "someone@example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "student_no": "STU-000001",
  "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "date_of_birth": "2026-10-30",
  "nationality": "text",
  "address": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/students" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Example","last_name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","preferred_name":"Example","email":"someone@example.com"}'
PUT/api/slcm/students/{id}Change a students

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_iduuidNoCampus
user_iduuidNoPortal sign-in — An older console sign-in for the student. Students now use the student portal: the Portal action on this row invites them.
first_nametextYesFirst name
last_nametextYesLast name
preferred_nametextNoPreferred name
emailtextNoEmail
phonetextNoPhone
date_of_birthdateNoDate of birth
nationalitytextNoNationality
addresstextNoAddress
emergency_contacttextNoEmergency contact
program_iduuidNoProgram
advisor_iduuidNoAdvisor
admit_term_iduuidNoAdmit term
expected_graduation_term_iduuidNoExpected graduation
enrollment_statustextNoLoad
Allowed: full_time part_time not_enrolled
statustextNoStatus
academic_standingtextNoAcademic standing
residencytextNoResidency
Allowed: in_state out_of_state international
cohorttextNoCohort
sponsor_account_iduuidNoFees billed to (sponsor) — An employer or scholarship body that pays this student’s fees. Leave blank and the bills are to the student.

Sample body

{
  "first_name": "Example",
  "last_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "student_no": "STU-000001",
  "applicant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "date_of_birth": "2026-10-30",
  "nationality": "text",
  "address": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/slcm/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Example","last_name":"Example"}'
DELETE/api/slcm/students/{id}Delete a students

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/slcm/students/{id}Patch student records

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

confirm_duplicate, duplicate_reason, review_later

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 PATCH "https://demo.tranxact.ai/api/slcm/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirm_duplicate":"value","duplicate_reason":"value","review_later":"value"}'
POST/api/slcm/students/{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/students/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/students/{parentId}/onboardingOnboarding

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

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

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/slcm/students/{parentId}/onboarding/{lineId}Onboarding

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/onboarding/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/slcm/students/{id}/degree-auditDegree audit

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/degree-audit" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/students/{id}/bill-termBill term

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

termId, dueDate

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/bill-term" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"termId":"value","dueDate":"value"}'
POST/api/slcm/students/{id}/holdsHolds

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

holdType*, reason, blocksRegistration, blocksTranscript, blocksGraduation; holdType one of financial|academic|disciplinary|health|library|advising|document|immunization

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/holds" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"holdType":"value","reason":"value","blocksRegistration":"value","blocksTranscript":"value","blocksGraduation;":"value"}'
GET/api/slcm/students/{id}/transcriptTranscript

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transcript" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/students/{id}/transition-to-alumniTransition to alumni

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

graduationYear, email, phone

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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transition-to-alumni" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graduationYear":"value","email":"value","phone":"value"}'

Data model

Every field of a students, 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, writeCampus
student_notextread onlyStudent no
applicant_iduuidread onlyApplicant id
user_iduuidread, writePortal sign-in — An older console sign-in for the student. Students now use the student portal: the Portal action on this row invites them.
first_nametextread, writeFirst name
last_nametextread, writeLast name
preferred_nametextread, writePreferred name
emailtextread, writeEmail
phonetextread, writePhone
date_of_birthdateread, writeDate of birth
nationalitytextread, writeNationality
addresstextread, writeAddress
emergency_contacttextread, writeEmergency contact
program_iduuidread, writeProgram
advisor_iduuidread, writeAdvisor
admit_term_iduuidread, writeAdmit term
expected_graduation_term_iduuidread, writeExpected graduation
enrollment_statustextread, writeLoad
Allowed: full_time part_time not_enrolled
statustextread, writeStatus
cumulative_creditsnumericread onlyCumulative credits
cumulative_gpanumericread onlyCumulative gpa
academic_standingtextread, writeAcademic standing
residencytextread, writeResidency
Allowed: in_state out_of_state international
cohorttextread, writeCohort
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
aid_grade_levelintegerread onlyAid grade level
housing_plantextread onlyHousing plan
account_iduuidread onlyAccount id
sponsor_account_iduuidread, writeFees billed to (sponsor) — An employer or scholarship body that pays this student’s fees. Leave blank and the bills are to the student.
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 › Student Records 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.