Correct an applicant
Corrects an applicant, following JSON Merge Patch (RFC 7386): a field you omit is left alone, a field you send as null is cleared, and an unknown field name is a 400.
givenName1, familyName, dob and emailAddress are what a person is created with, so they
can be changed but not cleared. givenName2, phoneNumber, postalAddress, sourceName and
sourceRef can be cleared, except that clearing sourceName while a sourceRef remains is
refused — an id with no system to interpret it is not findable.
Moving a sourceRef onto a pair another of your applicants already holds is a 409, naming the
applicant that holds it.
Identity really is mutable — a legal name change, a corrected typo, a new email address. That
is the argument for recording your own sourceRef: it goes on finding the person after any of
those.
Authentication
Paste a Keycloak access token (no "Bearer " prefix)
Path parameters
Request
Date of birth, ISO format YYYY-MM-DD.
Your own unique id for this person, e.g. a student number. Unique per sourceName.
Replaces ALL of your references for this record. Omit the field to leave them alone; send an empty array to remove them.
sourceName and sourceRef still edit the FIRST reference on its own and
leave any others untouched, so an existing integration is unaffected. If you
send both forms, sources wins.
Response
The supplied fields were applied; everything else is unchanged.
Your own unique id for this person, e.g. a student number. Unique per sourceName.
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.