TRANXACT.AI Help

Student Lifecycle · Services and actions

Portal

The portal service of Student Lifecycle: 2 operation(s).

Type REST2 operationsBase path /api/slcm/portal

Download specification (OpenAPI 3.1)

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 › Portal 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

POST/api/slcm/portal/{studentId}/aid-offer/respondAid offer respond

Path parameters

NameTypeDescription
studentIdstring (uuid)The record's studentId, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

accept, decision, award_ids, amounts

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/portal/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/aid-offer/respond" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accept":"value","decision":"value","award_ids":"value","amounts":"value"}'
GET/api/slcm/portal/{studentId}Read portal

Path parameters

NameTypeDescription
studentIdstring (uuid)The record's studentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/slcm/portal/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

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 › Portal 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.