/api/applicants/ID/notes

A request with the GET verb returns the current text in the notes box on the applicant card.

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

Content-Type: application/json
Content-Length: 1234

{
  "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",
  },
}

"Some comments"

Create a new applicant note

POST /api/applicants/123/notes
Host: apply.example.edu
Authorization: DREAM apikey="..."

• Note [1]: If both colour and color are specified, then colour is preferred.

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"

Content-Type: text/plain
Content-Length: 0