Points
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 points of the scoresheet score.
/api/v9/scoresheets/ID/scores/ID/pointsGET Get points
A request with the GET verb returns the score’s points as JSON encoded string (or null, if there are no points set). Note that 0 points is returned as “0” as it is a perfectly valid number of points.
GET /api/v9/scoresheets/123/scores/321/points
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/points"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 points value was successfully returned |
404 Not Found | The scoresheet does not have this score |
Example response
"90.00"PUT Set points
Set the points of a scoresheet score to a particular value. This will still run all validation checks and will not permit illegal point values to be entered that fall out of the accepted range as set in the scoresheet settings. If setting mapped values (for example if 5 = Excellent), the numeric value must be sent.
PUT /api/v9/scoresheets/123/scores/321/points
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
Write the JSON encoded points into the request body. Note that it is a JSON string, so it has to be enclosed in double quotes. You can set 0 points (which is perfectly valid) as “0” or “0.0” or “0.00”, as you please. But you cannot clear the points using this request. Please use the DELETE verb for that.
"3.14"Example request
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"3.14"' \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/points"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 points were successfully saved |
404 Not Found | The scoresheet does not have this score |
400 Bad Request | The points value did not pass the validation tests or is not a JSON string with double quotes. |
DELETE Delete points
Delete the points of a scoresheet score, resetting it to “not scored” which is distinct from a perfectly valid score of 0 points.
DELETE /api/v9/scoresheets/123/scores/321/points
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/points"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 points were successfully cleared |
404 Not Found | The scoresheet does not have this score |