Student Lifecycle · Students
Student Records
The record itself: program, advisor, standing, credits, GPA and what is blocking progress.
/api/slcm/studentsPublished as /api/v1/studentsDownload specification (OpenAPI 3.1) Screen: Student Records
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 › 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. |
| Table | slcm.students · 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
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/studentsList student records
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",
"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
| 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",
"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.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Campus |
user_id | uuid | No | Portal 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_name | text | Yes | First name |
last_name | text | Yes | Last name |
preferred_name | text | No | Preferred name |
email | text | No | |
phone | text | No | Phone |
date_of_birth | date | No | Date of birth |
nationality | text | No | Nationality |
address | text | No | Address |
emergency_contact | text | No | Emergency contact |
program_id | uuid | No | Program |
advisor_id | uuid | No | Advisor |
admit_term_id | uuid | No | Admit term |
expected_graduation_term_id | uuid | No | Expected graduation |
enrollment_status | text | No | Load Allowed: full_time part_time not_enrolled |
status | text | No | Status |
academic_standing | text | No | Academic standing |
residency | text | No | Residency Allowed: in_state out_of_state international |
cohort | text | No | Cohort |
sponsor_account_id | uuid | No | Fees 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
| 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 | Campus |
user_id | uuid | No | Portal 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_name | text | Yes | First name |
last_name | text | Yes | Last name |
preferred_name | text | No | Preferred name |
email | text | No | |
phone | text | No | Phone |
date_of_birth | date | No | Date of birth |
nationality | text | No | Nationality |
address | text | No | Address |
emergency_contact | text | No | Emergency contact |
program_id | uuid | No | Program |
advisor_id | uuid | No | Advisor |
admit_term_id | uuid | No | Admit term |
expected_graduation_term_id | uuid | No | Expected graduation |
enrollment_status | text | No | Load Allowed: full_time part_time not_enrolled |
status | text | No | Status |
academic_standing | text | No | Academic standing |
residency | text | No | Residency Allowed: in_state out_of_state international |
cohort | text | No | Cohort |
sponsor_account_id | uuid | No | Fees 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
| 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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PATCH/api/slcm/students/{id}Patch student records
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):
confirm_duplicate, duplicate_reason, review_laterResponse
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
| 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/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
| 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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/onboarding" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/students/{parentId}/onboardingOnboarding
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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/onboarding" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/students/{parentId}/onboarding/{lineId}Onboarding
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/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
| 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/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
| 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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/degree-audit" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/students/{id}/bill-termBill term
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):
termId, dueDateResponse
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
| 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):
holdType*, reason, blocksRegistration, blocksTranscript, blocksGraduation; holdType one of financial|academic|disciplinary|health|library|advising|document|immunizationResponse
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
| 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/students/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transcript" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/students/{id}/transition-to-alumniTransition to alumni
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):
graduationYear, email, phoneResponse
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.
| 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 | Campus |
student_no | text | read only | Student no |
applicant_id | uuid | read only | Applicant id |
user_id | uuid | read, write | Portal 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_name | text | read, write | First name |
last_name | text | read, write | Last name |
preferred_name | text | read, write | Preferred name |
email | text | read, write | |
phone | text | read, write | Phone |
date_of_birth | date | read, write | Date of birth |
nationality | text | read, write | Nationality |
address | text | read, write | Address |
emergency_contact | text | read, write | Emergency contact |
program_id | uuid | read, write | Program |
advisor_id | uuid | read, write | Advisor |
admit_term_id | uuid | read, write | Admit term |
expected_graduation_term_id | uuid | read, write | Expected graduation |
enrollment_status | text | read, write | Load Allowed: full_time part_time not_enrolled |
status | text | read, write | Status |
cumulative_credits | numeric | read only | Cumulative credits |
cumulative_gpa | numeric | read only | Cumulative gpa |
academic_standing | text | read, write | Academic standing |
residency | text | read, write | Residency Allowed: in_state out_of_state international |
cohort | text | read, write | Cohort |
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 |
aid_grade_level | integer | read only | Aid grade level |
housing_plan | text | read only | Housing plan |
account_id | uuid | read only | Account id |
sponsor_account_id | uuid | read, write | Fees 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_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 › Student Records 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.