This is an old revision of the document!


/api/applications/ID/offers/ID/decision

HEAD, GET

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 - offer was accepted by the applicant
  • Declined - offer was declined by the applicant
  • None - no decision yet

Syntax

GET /api/applications/123/offers/321/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1234

Response codes

200 OK The decision is returned successfully
404 Not Found Application does not have this offer

Response example

"Declined"

PUT

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.

:!: Please note that 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 call, so you have full control of marking the offers as you wish, but also the responsibility of not creating any strange situations.

Syntax

PUT /api/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.

"Declined"

Response headers

Content-Type: text/plain
Content-Length: 0

Response codes

200 OK Status was successfully set
400 Bad Request Invalid decision. Please make sure that status is a valid JSON string with quotes.
404 Not Found Application does not have this offer