Student Lifecycle · Early Alerts & Analytics
Alert Rules
When an early alert is raised without anybody pressing anything: attendance under the school’s minimum, absences in a row, fees past due — and when an overdue bill puts a hold on the student. One rule per school, or one for the whole company.
/api/slcm/alert-rulesPublished as /api/v1/alert-rulesOverview
| 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 › Alert Rules 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.alert_rules · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/alert-rulesList alert rules
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",
"name": "Example",
"attendance_min_pct": "1250.00",
"attendance_critical_pct": "1250.00",
"consecutive_absences": 10,
"min_sessions": 10,
"overdue_warn_days": 10,
"overdue_hold_days": 10,
"hold_blocks_registration": true,
"hold_blocks_transcript": true,
"hold_blocks_graduation": true,
"is_active": true,
"created_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/alert-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/alert-rules/{id}Read one alert rules
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",
"name": "Example",
"attendance_min_pct": "1250.00",
"attendance_critical_pct": "1250.00",
"consecutive_absences": 10,
"min_sessions": 10,
"overdue_warn_days": 10,
"overdue_hold_days": 10,
"hold_blocks_registration": true,
"hold_blocks_transcript": true,
"hold_blocks_graduation": true,
"is_active": true,
"created_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/alert-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/alert-rulesCreate a alert rules
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | School (blank for the whole company) — A school’s own rule wins over the company’s. With no rule at all: 75% minimum, 60% critical, 3 absences in a row, judged after 4 sessions, warned 1 day overdue, no hold. |
name | text | No | Name |
attendance_min_pct | numeric | No | Minimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended. |
attendance_critical_pct | numeric | No | Critical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own. |
consecutive_absences | integer | No | Absences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage. |
min_sessions | integer | No | Judge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section. |
overdue_warn_days | integer | No | Warn when fees are overdue by (days) — The student and finance are warned once per bill, and a financial alert is raised. Blank: never. |
overdue_hold_days | integer | No | Place a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold. |
hold_blocks_registration | boolean | No | The hold blocks registration |
hold_blocks_transcript | boolean | No | The hold blocks transcripts |
hold_blocks_graduation | boolean | No | The hold blocks graduation |
is_active | boolean | No | Active |
Sample body
{
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"attendance_min_pct": "1250.00",
"attendance_critical_pct": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"attendance_min_pct": "1250.00",
"attendance_critical_pct": "1250.00",
"consecutive_absences": 10,
"min_sessions": 10,
"overdue_warn_days": 10,
"overdue_hold_days": 10,
"hold_blocks_registration": true,
"hold_blocks_transcript": true,
"hold_blocks_graduation": true,
"is_active": true,
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/alert-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","attendance_min_pct":"1250.00","attendance_critical_pct":"1250.00"}'PUT/api/slcm/alert-rules/{id}Change a alert rules
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 |
|---|---|---|---|
org_unit_id | uuid | No | School (blank for the whole company) — A school’s own rule wins over the company’s. With no rule at all: 75% minimum, 60% critical, 3 absences in a row, judged after 4 sessions, warned 1 day overdue, no hold. |
name | text | No | Name |
attendance_min_pct | numeric | No | Minimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended. |
attendance_critical_pct | numeric | No | Critical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own. |
consecutive_absences | integer | No | Absences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage. |
min_sessions | integer | No | Judge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section. |
overdue_warn_days | integer | No | Warn when fees are overdue by (days) — The student and finance are warned once per bill, and a financial alert is raised. Blank: never. |
overdue_hold_days | integer | No | Place a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold. |
hold_blocks_registration | boolean | No | The hold blocks registration |
hold_blocks_transcript | boolean | No | The hold blocks transcripts |
hold_blocks_graduation | boolean | No | The hold blocks graduation |
is_active | boolean | No | Active |
Sample body
{
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name": "Example",
"attendance_min_pct": "1250.00",
"attendance_critical_pct": "1250.00",
"consecutive_absences": 10,
"min_sessions": 10,
"overdue_warn_days": 10,
"overdue_hold_days": 10,
"hold_blocks_registration": true,
"hold_blocks_transcript": true,
"hold_blocks_graduation": true,
"is_active": true,
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/alert-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example"}'DELETE/api/slcm/alert-rules/{id}Delete a alert rules
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/alert-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/alert-rules/{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/alert-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a alert rules, 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, write | School (blank for the whole company) — A school’s own rule wins over the company’s. With no rule at all: 75% minimum, 60% critical, 3 absences in a row, judged after 4 sessions, warned 1 day overdue, no hold. |
name | text | read, write | Name |
attendance_min_pct | numeric | read, write | Minimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended. |
attendance_critical_pct | numeric | read, write | Critical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own. |
consecutive_absences | integer | read, write | Absences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage. |
min_sessions | integer | read, write | Judge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section. |
overdue_warn_days | integer | read, write | Warn when fees are overdue by (days) — The student and finance are warned once per bill, and a financial alert is raised. Blank: never. |
overdue_hold_days | integer | read, write | Place a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold. |
hold_blocks_registration | boolean | read, write | The hold blocks registration |
hold_blocks_transcript | boolean | read, write | The hold blocks transcripts |
hold_blocks_graduation | boolean | read, write | The hold blocks graduation |
is_active | boolean | read, write | Active |
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 › Alert Rules 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.