Subject
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 subject of a scoresheet score.
URI
/api/v10/scoresheets/ID/score/ID/subjectGET Get the subject
Retrieve the score subject metadata.
This API request returns the subject metadata as a JSON encoded string or null, if no subject is stored.
Syntax
GET /api/v10/scoresheets/123/score/321/subject
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/subject"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 subject was successfully returned |
404 Not Found | The scoresheet does not have this score |
Example response
Response
"Mathematics"PUT Set the subject
Set the subject of a scoresheet score to the provided value.
Syntax
PUT /api/v10/scoresheets/123/scores/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a valid JSON string — the subject metadata enclosed in double quotes.
You cannot set the subject metadata to an empty value. Use the DELETE method for that.
Request body
"Chemistry"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Chemistry"' \
"https://apply.example.edu/api/v10/scoresheets/123/scores/321/subject"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 subject was successfully saved |
404 Not Found | The scoresheet does not have this score |
400 Bad Request | The subject code was not valid |
DELETE Delete the subject
Delete the subject of a scoresheet score.
Syntax
DELETE /api/v10/scoresheets/123/scores/321/subject
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/subject"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 subject was successfully cleared |
404 Not Found | The scoresheet does not have this score |