Get an applicant | UAC | Documentation

One applicant by our id. 404 if the id is unknown or belongs to another institution.

If you only have your own id for the person, use GET /institution/applicants?sourceRef=… .

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Path parameters

idstringRequiredformat: "uuid"

Response

The applicant.

idstringOptionalformat: "uuid"

givenName1stringOptional

givenName2stringOptional

givenNamesstringOptional

familyNamestringOptional

dobdateOptional

emailAddressstringOptional

phoneNumberstringOptional

postalAddressstringOptional

sourceNamestringOptional

The system this record was fed from, in your own vocabulary. Free text, and required whenever you send a sourceRef.

sourceRefstringOptional

Your own unique id for this person, e.g. a student number. Unique per sourceName.

sourceslist of objectsOptional

Your own references for this record, one per system you keep it in. A person or an application known by a different id in SITS than elsewhere carries both.

Optional. sourceName and sourceRef still work exactly as before and count as the FIRST entry here, so nothing you have already built needs to change. Send both forms and they are combined, with duplicates collapsed.

Order matters: the first entry is the one echoed back as sourceRef, and the one shown in lists and in the change feed.

Errors

404

Not Found Error