Reference
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 reference of the scoresheet score.
URI
/api/v9/scoresheets/ID/score/ID/referenceGET Get the reference
A request with the GET verb returns the score’s reference metadata as JSON encoded string (or null, if there is no reference stored).
Syntax
GET /api/v9/scoresheets/123/score/321/reference
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/123/scores/321/reference"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 reference was successfully returned |
404 Not Found | The scoresheet does not have this score |
Example response
Response
"Diploma nr. 789"PUT Set the reference
Set the reference of a scoresheet score to a particular value.
Syntax
PUT /api/v9/scoresheets/123/scores/321/reference
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
Write the JSON encoded reference metadata into the request body. Note that it is a JSON string, so it has to be enclosed in double quotes. Note that you cannot set a reference to an empty value, please use the DELETE verb for that.
Request body
"6073 7081 9027 8380"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"6073 7081 9027 8380"' \
"https://apply.example.edu/api/v9/scoresheets/123/scores/321/reference"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 reference was successfully saved |
404 Not Found | The scoresheet does not have this score |
400 Bad Request | The reference code was not valid |
DELETE Delete the reference
Delete the reference of a scoresheet score.
Syntax
DELETE /api/v9/scoresheets/123/scores/321/reference
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/v9/scoresheets/123/scores/321/reference"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 reference was successfully cleared |
404 Not Found | The scoresheet does not have this score |