Offer decision
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 application offer decision.
/api/v9/applications/ID/offers/ID/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."GET Get the offer decision
A request with the GET verb returns the decision that the applicant has made (or has been made by admin on behalf of the applicant) regarding this offer.
It can be one of three:
- Final: The offer was accepted by the applicant
- Declined: The offer was declined by the applicant
- None: No decision yet
GET /api/v9/applications/123/offers/321/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/offers/321/decision"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 decision was successfully returned |
404 Not Found | The application does not have this offer |
Example response
"Declined"PUT Set the offer decision
Set the decision on behalf of the applicant regarding a specific offer. For example, you can mark an offer to be declined, or make it the final decision (acceptance) for an applicant.
Normally, when an applicant makes a decision, there are rules such as when you make a final decision for one offer, other offers are declined. Or that you cannot have multiple final offers on a single application. None of those checks run with this API request, so you have full control of marking the offers as you wish, but also the responsibility of not creating any strange situations.
PUT /api/v9/applications/123/offers/321/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
This will be set as the decision of the application offer in question, upon successful validation: None, Final or Declined.
"Declined"Example request
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Declined"' \
"https://apply.example.edu/api/v9/applications/123/offers/321/decision"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 |
|---|---|
200 OK | The status was successfully set. |
400 Bad Request | Invalid decision. Please make sure that status is a valid JSON string with quotes. |
404 Not Found | The application does not have this offer. |