Reference code

Represents the reference code for the applicant.

/api/v9/applicants/ID/reference

GET Get a reference code

A request with the GET verb returns the JSON-encoded reference value for this applicant. Note that the value appears to be a double-quoted value, but is a JSON string literal in the strict sense. If there is no reference value, null is returned.

A reference value can be anything, usually it is the applicant’s ID or code in another related system, for example the applicant’s student ID in the Study Information System (SIS).

GET /api/v9/applicants/123/reference
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applicants/123/reference"

Response headers

Response codes

Example response

"ABC123"

PUT Set a reference code

When making a PUT request, the contents of the request body will be stored as the new reference value for the applicant in question.

The body must be a JSON encoded string literal, this means that it has to be double-quoted like "ABC123", not just ABC123. A minimum of 3 and a maximum 16 characters are allowed and the reference value can only contain uppercase letters, numbers, dots, dashes and slashes.

PUT /api/v9/applicants/123/reference
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X PUT \
  -d '"ABC123"' \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applicants/123/reference"

Response headers

Response codes