Comments
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 the comments for the scoresheet score.
URI
/api/v9/scoresheets/ID/scores/ID/commentsGET Get comments
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/v9/scoresheets/123/score/321/comments
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/scoresheets/123/scores/321/comments"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 comments were successfully returned |
404 Not Found | The scoresheet does not have this score |
Example response
Response
"Some comments"PUT Add comments
Set the comments of a scoresheet score to a particular text.
Syntax
PUT /api/v9/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.
Request body
"Some comments"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Some comments"' \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/comments"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 comments were successfully saved |
404 Not Found | The scoresheet does not have this score |
400 Bad Request | The comments text was not valid (empty or too long) |
DELETE Delete comments
Delete the comments of a scoresheet score.
Syntax
DELETE /api/v9/scoresheets/123/scores/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/comments"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 comments were successfully cleared |
404 Not Found | Scoresheet does not have this score |