Notes
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 a list of notes on the applicant.
URI
/api/v9/applicants/ID/notesThe PUT /api/applicants/ID/notes request was discontinued starting from version 6. To create a new note, use the POST method instead. For backwards compatibility, the PATCH method is supported, but is deprecated.
GET List notes
A request with the GET verb returns the current text in the notes box on the applicant card.
Syntax
GET /api/v9/applicants/123/notes
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/notes"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 list of notes was successfully returned |
Example response
Response
curl
{
"1": {
"created": "1970-01-01T00:00:01+00:00",
"removed": null,
"colour": "Yellow",
"pinned": false,
"collapsed": false,
"Notes": "Some comments"
},
"2": {
"created": "1970-01-01T00:00:01+00:00",
"removed": null,
"colour": "Salmon",
"pinned": true,
"collapsed": false,
"Notes": "Some other comments"
}
}Response
curl
"Some comments"POST Add a note
Create a new applicant note.
Syntax
POST /api/v9/applicants/123/notes
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description | Notes |
|---|---|---|---|
colour | Optional | Specify the colour of the (sticky) note: Yellow, Orange, Salmon, Green, Blue, Violet | |
color | Optional | An alias for colour | If both colour and color are specified, then colour is preferred. |
Raw request body
The comments have to be a proper JSON string token. In a JSON string only space is allowed per the specification, newlines, for example, have to be encoded.
Request body
"Some notes\nAnother line"Example request
Request
curl
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Your notes here \nAnother line"' \
"https://apply.example.edu/api/v9/applicants/123/notes"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The notes were successfully saved |
400 Bad Request | Invalid notes, please make sure that status is a valid JSON string with quotes |