Applicant on DreamApply Knowledge Base

Photo

Mon, 01 Jan 0001 00:00:00 +0000

Represents the applicant’s photo.

URI

/api/v9/applicants/ID/photo

Get a photo

Return the applicant’s photo data.

Syntax

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

Parameters

Name	Required/Optional	Description	Notes
`size`	Optional	Requested transformed size of photo, possible values are `S`, `M`, `L`, `R`, `F`.	The default value is `F` which applies the existing transformations, while `R` can skip all transformations and return the raw image.

Example request

Request

 curl
 
 
curl \
 -X GET \
 -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
 -o ~/Downloads/photo_123.jpeg \
 "https://apply.example.edu/api/v9/applicants/123/photo"

Response headers

Header	Value	Description
`Content-Type`	`image/jpeg`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The applicant’s binary photo was successfully returned
`404 Not Found`	The applicant does not have a photo

Reference code

Mon, 01 Jan 0001 00:00:00 +0000

Represents the reference code for the applicant.

URI

/api/v9/applicants/ID/reference

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

Matriculation number

Mon, 01 Jan 0001 00:00:00 +0000

Represents the matriculation number for the applicant.

URI

/api/v9/applicants/ID/matriculation

Get a matriculation number

A request with the GET verb returns the JSON-encoded matriculation number 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 matriculation number, null is returned.

Syntax

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

Example request

Request

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

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The matriculation number was successfully returned

Example response

Response

 curl
 
"ABC123"

Set a matriculation number

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

Applicant on DreamApply Knowledge Base

Photo

GET Get a photo

Parameters

Example request

Response headers

Response codes

Reference code

GET Get a reference code

Matriculation number

GET Get a matriculation number

Example request

Response headers

Response codes

Example response

PUT Set a matriculation number

Get a photo

Get a reference code

Get a matriculation number

Set a matriculation number