Student Lifecycle · Completion
Alumni
The relationship after graduation: where they went, and whether they will give or mentor.
/api/slcm/alumniPublished as /api/v1/alumniOverview
| 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 › Alumni 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.alumni · 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/alumniList alumni
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",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"current_employer": "text",
"current_title": "Example",
"industry": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address": "text",
"mentor_willing": true,
"donor_status": "none",
"lifetime_giving": "1250.00",
"engagement_score": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/alumni?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/alumni/{id}Read one alumni
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",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"current_employer": "text",
"current_title": "Example",
"industry": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address": "text",
"mentor_willing": true,
"donor_status": "none",
"lifetime_giving": "1250.00",
"engagement_score": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/alumni/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/alumniCreate a alumni
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
student_id | uuid | Yes | Student |
graduation_year | text | No | Graduation year |
program_id | uuid | No | Program |
current_employer | text | No | Current employer |
current_title | text | No | Current role |
industry | text | No | Industry |
email | text | No | |
phone | text | No | Phone |
address | text | No | Address |
mentor_willing | boolean | No | Willing to mentor |
donor_status | text | No | Donor status Allowed: none prospect donor major_donor lapsed |
lifetime_giving | numeric | No | Lifetime giving |
engagement_score | numeric | No | Engagement score |
last_contact_at | date | No | Last contact |
notes | text | No | Notes |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"current_employer": "text",
"current_title": "Example"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"current_employer": "text",
"current_title": "Example",
"industry": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address": "text",
"mentor_willing": true,
"donor_status": "none",
"lifetime_giving": "1250.00",
"engagement_score": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/alumni" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","graduation_year":"text","program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","current_employer":"text","current_title":"Example"}'PUT/api/slcm/alumni/{id}Change a alumni
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 |
graduation_year | text | No | Graduation year |
program_id | uuid | No | Program |
current_employer | text | No | Current employer |
current_title | text | No | Current role |
industry | text | No | Industry |
email | text | No | |
phone | text | No | Phone |
address | text | No | Address |
mentor_willing | boolean | No | Willing to mentor |
donor_status | text | No | Donor status Allowed: none prospect donor major_donor lapsed |
lifetime_giving | numeric | No | Lifetime giving |
engagement_score | numeric | No | Engagement score |
last_contact_at | date | No | Last contact |
notes | text | No | Notes |
Sample body
{
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"graduation_year": "text",
"program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"current_employer": "text",
"current_title": "Example",
"industry": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"address": "text",
"mentor_willing": true,
"donor_status": "none",
"lifetime_giving": "1250.00",
"engagement_score": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/alumni/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"student_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","graduation_year":"text"}'DELETE/api/slcm/alumni/{id}Delete a alumni
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/alumni/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/alumni/{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/alumni/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 alumni, 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 |
student_id | uuid | read, write | Student |
graduation_year | text | read, write | Graduation year |
program_id | uuid | read, write | Program |
current_employer | text | read, write | Current employer |
current_title | text | read, write | Current role |
industry | text | read, write | Industry |
email | text | read, write | |
phone | text | read, write | Phone |
address | text | read, write | Address |
mentor_willing | boolean | read, write | Willing to mentor |
donor_status | text | read, write | Donor status Allowed: none prospect donor major_donor lapsed |
lifetime_giving | numeric | read, write | Lifetime giving |
engagement_score | numeric | read, write | Engagement score |
last_contact_at | date | read, write | Last contact |
notes | text | read, write | Notes |
transitioned_at | timestamp with time zone | read only | Transitioned at |
org_unit_id | uuid | read only | Org unit id |
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 › Alumni 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.