Skip to navigation
UNSW Advance Institution APIApplicants

Look up applicants

View as Markdown

Finds applicants, either way round:

  • by your own id: send sourceRef (optionally with sourceName to name the system it belongs to). The identity parameters are then ignored. Returns at most one applicant.
  • by identity: send ALL of givenNames, familyName, dob (YYYY-MM-DD) and emailAddress. Names and email are matched case-insensitively.

Prefer the first when you have it: an id survives a name change or a corrected typo, where identity matching would miss the person entirely.

Returns an array, empty if nothing matches.

Authentication

AuthorizationBearer

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

Query parameters

dobstringOptional
emailAddressstringOptional
familyNamestringOptional
givenName1stringOptional
sourceNamestringOptional

The system sourceRef belongs to, e.g. "SITS". Optional; omit to search every system.

sourceRefstringOptional
Your own id for the person, e.g. a student number. When given, the identity parameters are ignored.

Response

OK
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.