Student Lifecycle · Financial Aid (US)
Aid Applications
One per student per award year, from the ISIR: SAI, cost of attendance, need, verification and C-code status. Propose a package, offer it, and the student answers in the portal.
/api/slcm/aid-applicationsPublished as /api/v1/aid-applicationsDownload specification (OpenAPI 3.1) Screen: Aid Applications
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 › Aid Applications 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.aid_applications · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/aid-applicationsList aid applications
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",
"application_no": "APP-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text",
"current_isir_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transaction_number": 10,
"sai": 10,
"dependency_status": "draft",
"pell_eligible": true,
"verification_status": "draft",
"verification_group": "text",
"c_code_status": "draft",
"intensity": "full_time"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/aid-applications?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/aid-applications/{id}Read one aid applications
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",
"application_no": "APP-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text",
"current_isir_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transaction_number": 10,
"sai": 10,
"dependency_status": "draft",
"pell_eligible": true,
"verification_status": "draft",
"verification_group": "text",
"c_code_status": "draft",
"intensity": "full_time"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-applicationsCreate a aid applications
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
student_id | uuid | Yes | Student |
award_year | text | Yes | Award year |
intensity | text | No | Enrolment intensity — Blank: from the student’s full or part time status. Allowed: full_time three_quarter half_time less_than_half |
housing | text | No | Housing — Blank: from the student’s housing plan. Allowed: on_campus off_campus with_parents |
grade_level | integer | No | Grade level — 1, 2, 3 and above; 6 for graduate. |
other_aid | numeric | No | Other resources — Outside scholarships and benefits; they reduce need. |
notes | text | No | Notes |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text",
"intensity": "full_time",
"housing": "on_campus",
"grade_level": 10,
"other_aid": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_no": "APP-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text",
"current_isir_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transaction_number": 10,
"sai": 10,
"dependency_status": "draft",
"pell_eligible": true,
"verification_status": "draft",
"verification_group": "text",
"c_code_status": "draft",
"intensity": "full_time"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/aid-applications" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","award_year":"text","intensity":"full_time","housing":"on_campus","grade_level":10,"other_aid":"1250.00"}'PUT/api/slcm/aid-applications/{id}Change a aid applications
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 |
|---|---|---|---|
student_id | uuid | Yes | Student |
award_year | text | Yes | Award year |
intensity | text | No | Enrolment intensity — Blank: from the student’s full or part time status. Allowed: full_time three_quarter half_time less_than_half |
housing | text | No | Housing — Blank: from the student’s housing plan. Allowed: on_campus off_campus with_parents |
grade_level | integer | No | Grade level — 1, 2, 3 and above; 6 for graduate. |
other_aid | numeric | No | Other resources — Outside scholarships and benefits; they reduce need. |
notes | text | No | Notes |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"application_no": "APP-000001",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"award_year": "text",
"current_isir_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"transaction_number": 10,
"sai": 10,
"dependency_status": "draft",
"pell_eligible": true,
"verification_status": "draft",
"verification_group": "text",
"c_code_status": "draft",
"intensity": "full_time"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","award_year":"text"}'DELETE/api/slcm/aid-applications/{id}Delete a aid applications
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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-applications/{id}/assign-coaAssign coa
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):
budget_idResponse
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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign-coa" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"budget_id":"value"}'POST/api/slcm/aid-applications/{id}/packagePackage
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/package" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-applications/{id}/offerOffer
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/offer" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/aid-applications/{id}/award-letterAward letter
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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/award-letter" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/aid-applications/{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/aid-applications/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 aid applications, 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 |
application_no | text | read only | Application no |
student_id | uuid | read, write | Student |
award_year | text | read, write | Award year |
current_isir_id | uuid | read only | Current isir id |
transaction_number | integer | read only | Transaction number |
sai | integer | read only | Sai |
dependency_status | text | read only | Dependency status |
pell_eligible | boolean | read only | Pell eligible |
verification_status | text | read only | Verification status |
verification_group | text | read only | Verification group |
c_code_status | text | read only | C code status |
intensity | text | read, write | Enrolment intensity — Blank: from the student’s full or part time status. Allowed: full_time three_quarter half_time less_than_half |
housing | text | read, write | Housing — Blank: from the student’s housing plan. Allowed: on_campus off_campus with_parents |
grade_level | integer | read, write | Grade level — 1, 2, 3 and above; 6 for graduate. |
coa_budget_id | uuid | read only | Coa budget id |
coa_amount | numeric | read only | Coa amount |
other_aid | numeric | read, write | Other resources — Outside scholarships and benefits; they reduce need. |
need | numeric | read only | Need |
proposed_package | jsonb | read only | Proposed package |
status | text | read only | Status |
offered_at | timestamp with time zone | read only | Offered at |
responded_at | timestamp with time zone | read only | Responded at |
notes | text | read, write | Notes |
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 › Aid Applications 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.