Scoresheets
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 scoresheets created in the system.
URI
/api/v9/scoresheetsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/scoresheets | C | GET, HEAD | List all scoresheets |
/api/v9/scoresheets/ID | R | GET, HEAD | Get info about a scoresheet |
/api/v9/scoresheets/ID/scores | C | GET, HEAD | Get scores |
/api/v9/scoresheets/ID/scores | C | POST | Append an application for scoring |
/api/v9/scoresheets/ID/scores/id | R | GET, HEAD | Get information about a score (points & metadata) |
/api/v9/scoresheets/ID/scores/id | R | PUT | Overwrite a score (points & metadata) |
/api/v9/scoresheets/ID/scores/id | R | PATCH | Update a score (points &metadata) |
/api/v9/scoresheets/ID/scores/id/points | R | GET, HEAD | Get the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/points | R | PUT | Set the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/points | R | DELETE | Clear the points of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | GET, HEAD | Get the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | PUT | Set the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/comments | R | DELETE | Clear the comments of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | GET, HEAD | Get the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | PUT | Set the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/date | R | DELETE | Clear the date of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | GET, HEAD | Get the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | PUT | Set the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/language | R | DELETE | Clear the language of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | GET, HEAD | Get the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | PUT | Set the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/reference | R | DELETE | Clear the reference of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | GET, HEAD | Get the subject of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | PUT | Set the subject of a scoresheet score |
/api/v9/scoresheets/ID/scores/id/subject | R | DELETE | Clear the subject of a scoresheet score |
GET List scoresheets
List scoresheets that are available via the API.
Syntax
GET /api/v9/scoresheets
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"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 created scoresheets |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of scoresheets was successfully returned |
Example response
Response
{
"1": {
"created": "2023-07-01T10:00:00+00:00",
"scored": "2025-12-11T11:48:52+00:00",
"confirmed": null,
"name": "English proficiency (IELTS)",
"type": "IELTS",
"date": "Optional",
"depth": "Application",
"range_min": 4.5,
"range_max": 9.5,
"scale": 1,
"instructions": "Please provide your IELTS test results in the designated fields. If you have taken an alternative English proficiency test like TOEFL, you may skip specifying a IELTS score.",
"reference": "Required",
"subject": "None",
"language": "None"
},
"2": {
"created": "2025-02-10T12:44:43+00:00",
"scored": "2025-08-22T12:35:07+00:00",
"confirmed": null,
"name": "Academic performance (computer science)",
"type": "Number",
"date": "None",
"depth": "Application",
"range_min": 1,
"range_max": 10,
"scale": 0,
"instructions": "Please provide high school examination results in computer science here.",
"reference": "None",
"subject": "None",
"language": "None"
}
}