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 a scoresheet score.
URI
/api/v10/scoresheets/ID/scores/ID/commentsGET Get comments
Retrieve the score comments.
This API request returns comments as a JSON encoded string or null, if no comments are stored.
Syntax
GET /api/v10/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/v10/scoresheets/123/scores/321/comments"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The 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 the provided text.
Syntax
PUT /api/v10/scoresheets/123/scores/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a valid JSON string — comments enclosed in double quotes. The allowed length is up to 512 characters.
You cannot set comments to an empty value. Use the DELETE method 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/v10/scoresheets/123/scores/321/comments"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The 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 for a scoresheet score.
Syntax
DELETE /api/v10/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/v10/scoresheets/123/scores/321/comments"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The comments were successfully cleared |
404 Not Found | The scoresheet does not have this score |