Extra score
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 extra score set for an offer.
URI
/api/v10/applications/ID/offers/ID/score/extraGET Get the extra score
Retrieve the extra score set for an offer.
Syntax
GET /api/v10/applications/123/offers/321/score/extra
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/applications/123/offers/321/score/extra"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 extra score was successfully returned |
404 Not Found | The application does not have this offer |
Example response
Response
"82.46"PUT Set the extra score
Set the extra score for an offer.
The API request checks if the specified score is a valid value and assigns it to the application offer upon successful validation.
Syntax
PUT /api/v10/applications/123/offers/321/score/extra
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a decimal value with 2 decimal points separated by a dot, enclosed in double quotes. Upon successful validation, the provided value is saved as the extra score for the offer.
Request body
"25.50"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"25.50"' \
"https://apply.example.edu/api/v10/applications/123/offers/321/score/extra"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 |
|---|---|
200 OK | The extra score was successfully set. |
400 Bad Request | Invalid input. |
400 Bad Request | An invalid score. The score must be a decimal value with 2 decimal points separated by a dot. |
404 Not Found | The application does not have this offer. |
DELETE Delete the extra score
Clear the extra score for an offer.
Syntax
DELETE /api/v10/applications/123/offers/321/score/extra
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/applications/123/offers/321/score/extra"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 score was successfully cleared |
400 Bad Request | Invalid input |