Photo
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents the applicant’s photo.
URI
/api/v9/applicants/ID/photoGET 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 |