/api/applications/ID/offers/ID/notes
HEAD, GET
A request with the GET verb returns the current text in the notes box on the offer card.
Syntax
GET /api/applications/123/offers/321/notes Host: apply.example.edu Authorization: DREAM apikey="..."
Response headers
Content-Type: application/json Content-Length: 1234
Response codes
200 OK | The notes were returned successfully |
404 Not Found | Application does not have this offer |
Response example
API version >= 6
{
"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",
},
}
API version < 6
"Some comments"
POST
Create a new offer note.
Syntax
POST /api/applications/123/offers/321/notes Host: apply.example.edu Authorization: DREAM apikey="..."
Parameters
| Name | Description | Notes | |
|---|---|---|---|
colour | Optional | Specify the colour of the (sticky) note: Yellow, Orange, Salmon, Green, Blue, Violet | |
color | Optional | An alias for colour | [1] |
- Note [1]: If both
colourandcolorare specified, thencolouris preferred.
Raw request body
Note that 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.
"Some notes\nAnother line"
Response headers
Content-Type: text/plain Content-Length: 0
Response codes
204 No Content | The notes were saved |
400 Bad Request | Invalid notes. Please make sure that status is a valid JSON string with quotes. |
404 Not Found | Application does not have this offer |