TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/slcm/aid-applicationsPublished as /api/v1/aid-applications

Download specification (OpenAPI 3.1) Screen: Aid Applications

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

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

GET/api/slcm/aid-applicationsList aid applications

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

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

FieldTypeRequiredDescription
student_iduuidYesStudent
award_yeartextYesAward year
intensitytextNoEnrolment intensity — Blank: from the student’s full or part time status.
Allowed: full_time three_quarter half_time less_than_half
housingtextNoHousing — Blank: from the student’s housing plan.
Allowed: on_campus off_campus with_parents
grade_levelintegerNoGrade level — 1, 2, 3 and above; 6 for graduate.
other_aidnumericNoOther resources — Outside scholarships and benefits; they reduce need.
notestextNoNotes

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

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
student_iduuidYesStudent
award_yeartextYesAward year
intensitytextNoEnrolment intensity — Blank: from the student’s full or part time status.
Allowed: full_time three_quarter half_time less_than_half
housingtextNoHousing — Blank: from the student’s housing plan.
Allowed: on_campus off_campus with_parents
grade_levelintegerNoGrade level — 1, 2, 3 and above; 6 for graduate.
other_aidnumericNoOther resources — Outside scholarships and benefits; they reduce need.
notestextNoNotes

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

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/aid-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/aid-applications/{id}/assign-coaAssign coa

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

budget_id

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/assign-coa" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"budget_id":"value"}'
POST/api/slcm/aid-applications/{id}/packagePackage

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
application_notextread onlyApplication no
student_iduuidread, writeStudent
award_yeartextread, writeAward year
current_isir_iduuidread onlyCurrent isir id
transaction_numberintegerread onlyTransaction number
saiintegerread onlySai
dependency_statustextread onlyDependency status
pell_eligiblebooleanread onlyPell eligible
verification_statustextread onlyVerification status
verification_grouptextread onlyVerification group
c_code_statustextread onlyC code status
intensitytextread, writeEnrolment intensity — Blank: from the student’s full or part time status.
Allowed: full_time three_quarter half_time less_than_half
housingtextread, writeHousing — Blank: from the student’s housing plan.
Allowed: on_campus off_campus with_parents
grade_levelintegerread, writeGrade level — 1, 2, 3 and above; 6 for graduate.
coa_budget_iduuidread onlyCoa budget id
coa_amountnumericread onlyCoa amount
other_aidnumericread, writeOther resources — Outside scholarships and benefits; they reduce need.
neednumericread onlyNeed
proposed_packagejsonbread onlyProposed package
statustextread onlyStatus
offered_attimestamp with time zoneread onlyOffered at
responded_attimestamp with time zoneread onlyResponded at
notestextread, writeNotes
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 › Aid Applications 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.