/api/scoresheets/ID/score/ID/comments

HEAD, GET

A request with the GET verb returns the score's comments as JSON encoded string (or null, if there are no comments stored).

Syntax

GET /api/scoresheets/123/score/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

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

Response codes

200 OK The comments are returned successfully
404 Not Found Scoresheet does not have this score

Response example

"Some comments"

PUT

Set the comments of a scoresheet score to a particular text.

Syntax

PUT /api/scoresheets/123/scores/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Raw request body

Write the JSON encoded comments into the request body. Note that it is a JSON string, so it has to be enclosed in double quotes. The maximum allowed length is 512 characters. Note that you cannot set comments to an empty value, please use the DELETE verb for that.

"Some comments"

Response headers

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

Response codes

204 No Content The comments were successfully saved
404 Not Found Scoresheet does not have this score
400 Bad Request The comments text was not valid (empty or too long)

DELETE

Delete the comments of a scoresheet score.

Syntax

DELETE /api/scoresheets/123/scores/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

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

Response codes

204 No Content The points were successfully cleared
404 Not Found Scoresheet does not have this score