Points

Represents the points of a scoresheet score.

/api/v10/scoresheets/ID/scores/ID/points

GET Get points

Retrieve the score points.

This API request returns points as a JSON encoded string or null, if no points are set. 0 points is returned as 0 as it is a perfectly valid number of points.

GET /api/v10/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/v10/scoresheets/123/scores/321/points"

Response headers

Response codes

Example response

"90.00"

PUT Set points

Set the points of a scoresheet score to the provided value.

This API request runs all validation checks and does not accept illegal point values that fall out of the accepted range (as defined in the scoresheet settings). If mapped values are set (for example, if 5 = Excellent), the numeric value must be sent.

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

Raw request body

The request body must contain a valid JSON string — points enclosed in double quotes.

You can set 0 points (which is perfectly valid) as 0 or 0.0 or 0.00. However, you cannot clear the score points using this request. Use the DELETE method for that.

"3.14"

Example request

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -d '"3.14"' \
  "https://apply.example.edu/api/v10/scoresheets/123/scores/321/points"

Response headers

Response codes

DELETE Delete points

Delete the points of a scoresheet score.

This API request resets the score points to “not scored”, which is distinct from a perfectly valid score of 0 points.

DELETE /api/v10/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/v10/scoresheets/123/scores/321/points"

Response headers

Response codes