TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/slcm/alert-rulesPublished as /api/v1/alert-rules

Download specification (OpenAPI 3.1) Screen: Alert Rules

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

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

GET/api/slcm/alert-rulesList alert rules

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

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

FieldTypeRequiredDescription
org_unit_iduuidNoSchool (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.
nametextNoName
attendance_min_pctnumericNoMinimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended.
attendance_critical_pctnumericNoCritical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own.
consecutive_absencesintegerNoAbsences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage.
min_sessionsintegerNoJudge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section.
overdue_warn_daysintegerNoWarn 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_daysintegerNoPlace a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold.
hold_blocks_registrationbooleanNoThe hold blocks registration
hold_blocks_transcriptbooleanNoThe hold blocks transcripts
hold_blocks_graduationbooleanNoThe hold blocks graduation
is_activebooleanNoActive

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

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
org_unit_iduuidNoSchool (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.
nametextNoName
attendance_min_pctnumericNoMinimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended.
attendance_critical_pctnumericNoCritical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own.
consecutive_absencesintegerNoAbsences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage.
min_sessionsintegerNoJudge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section.
overdue_warn_daysintegerNoWarn 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_daysintegerNoPlace a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold.
hold_blocks_registrationbooleanNoThe hold blocks registration
hold_blocks_transcriptbooleanNoThe hold blocks transcripts
hold_blocks_graduationbooleanNoThe hold blocks graduation
is_activebooleanNoActive

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread, writeSchool (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.
nametextread, writeName
attendance_min_pctnumericread, writeMinimum attendance (%) — Below this in any section raises an attendance alert. Present, late, remote and excused all count as attended.
attendance_critical_pctnumericread, writeCritical below (%) — Below this the alert is high severity, and the risk score calls it high risk on its own.
consecutive_absencesintegerread, writeAbsences in a row — This many of the latest sessions missed in a row raises an alert whatever the percentage.
min_sessionsintegerread, writeJudge attendance after (sessions) — A percentage is not judged until a student has this many sessions recorded in the section.
overdue_warn_daysintegerread, writeWarn 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_daysintegerread, writePlace a hold when overdue by (days) — Blank: no hold is ever placed for overdue fees. Paying the bill releases the hold.
hold_blocks_registrationbooleanread, writeThe hold blocks registration
hold_blocks_transcriptbooleanread, writeThe hold blocks transcripts
hold_blocks_graduationbooleanread, writeThe hold blocks graduation
is_activebooleanread, writeActive
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 › Alert Rules 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.