Note

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

Represent a single note on the applicant.

URI

/api/v9/applicants/ID/notes/ID

Get a note

A request with the GET verb returns information about one specific (sticky) note on the applicant record.

Syntax

GET /api/v9/applicants/123/notes/321
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/321"

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 note data was successfully returned

Example response

Response

 curl
 
 
{
 "created": "1970-01-01T00:00:01+00:00",
 "removed": null,
 "colour": "Yellow",
 "pinned": false,
 "collapsed": false,
 "Notes": "Some comments"
}

Response

 curl
 
"Some comments"

Update a note

Update one specific applicant (sticky) note.

Notes on DreamApply Knowledge Base