Scores
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 a list of all scores on the scoresheet.
URI
/api/v9/scoresheets/ID/scoresGET List scores
Return scores list for the scoresheet.
Syntax
GET /api/v9/scoresheets/123/scores
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description |
|---|---|---|
byAcademicTermID | Required | The academic term to filter by. |
Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/scoresheets/1/scores?byAcademicTermID=2"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
X-Count | 15 | Number of entered scores |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of scores was successfully returned |
Example response
Response
{
"1000": {
"scored": "2025-12-17T08:42:28+00:00",
"scoresheet": "/api/v9/scoresheets/4",
"application": "/api/v9/applications/123",
"offer": null,
"points": "65.00",
"comments": null,
"date": "2025-02-01",
"reference": "BG450-009",
"subject": null,
"language": null
},
"1001": {
"scored": "2025-12-17T08:42:28+00:00",
"scoresheet": "/api/v9/scoresheets/4",
"application": "/api/v9/applications/124",
"offer": null,
"points": "87.00",
"comments": null,
"date": "2024-12-10",
"reference": "GE789-110",
"subject": null,
"language": null
}
}POST Add an application to the scoresheet
Append an application to the scoresheet in question. If the application is already on this scoresheet, it will just update the score (and optionally, the comments).
Syntax
POST /api/v9/scoresheets/123/scores
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description |
|---|---|---|
application | Required | An application ID to add |
points | Required | The points to set for this scoresheet score. Validation depends on the scoresheet settings. In case of a mapped-type value, it takes the numeric equivalent. |
comments | Optional | Up to 512 characters of comments. May be omitted or left empty in which case it has no effect (including leaving any existing comments in place). |
Example request
Request
curl
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/scoresheets/123/scores?application=321&points=80&comments=Copied%20from%20transcript"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
201 Created | The application was successfully added to the scoresheet and the score data was updated |