TRANXACT.AI Help

Student Lifecycle · Completion

Alumni

The relationship after graduation: where they went, and whether they will give or mentor.

Type REST6 operationsBase path /api/slcm/alumniPublished as /api/v1/alumni

Download specification (OpenAPI 3.1) Screen: Alumni

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 › 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.
Tableslcm.alumni · 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/alumniList alumni

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

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

FieldTypeRequiredDescription
student_iduuidYesStudent
graduation_yeartextNoGraduation year
program_iduuidNoProgram
current_employertextNoCurrent employer
current_titletextNoCurrent role
industrytextNoIndustry
emailtextNoEmail
phonetextNoPhone
addresstextNoAddress
mentor_willingbooleanNoWilling to mentor
donor_statustextNoDonor status
Allowed: none prospect donor major_donor lapsed
lifetime_givingnumericNoLifetime giving
engagement_scorenumericNoEngagement score
last_contact_atdateNoLast contact
notestextNoNotes

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

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
graduation_yeartextNoGraduation year
program_iduuidNoProgram
current_employertextNoCurrent employer
current_titletextNoCurrent role
industrytextNoIndustry
emailtextNoEmail
phonetextNoPhone
addresstextNoAddress
mentor_willingbooleanNoWilling to mentor
donor_statustextNoDonor status
Allowed: none prospect donor major_donor lapsed
lifetime_givingnumericNoLifetime giving
engagement_scorenumericNoEngagement score
last_contact_atdateNoLast contact
notestextNoNotes

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
student_iduuidread, writeStudent
graduation_yeartextread, writeGraduation year
program_iduuidread, writeProgram
current_employertextread, writeCurrent employer
current_titletextread, writeCurrent role
industrytextread, writeIndustry
emailtextread, writeEmail
phonetextread, writePhone
addresstextread, writeAddress
mentor_willingbooleanread, writeWilling to mentor
donor_statustextread, writeDonor status
Allowed: none prospect donor major_donor lapsed
lifetime_givingnumericread, writeLifetime giving
engagement_scorenumericread, writeEngagement score
last_contact_atdateread, writeLast contact
notestextread, writeNotes
transitioned_attimestamp with time zoneread onlyTransitioned at
org_unit_iduuidread onlyOrg unit id
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 › Alumni 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.