A request with the GET
verb returns the offer letter text (“comments”) for this particular offer (identified by offer ID).
GET /api/applications/123/offers/321/comments Host: apply.example.edu Authorization: DREAM apikey="..."
Content-Type: application/json Content-Length: 1234
200 OK | The offer letter text (“comments”) was returned successfully |
404 Not Found | Application does not have this offer |
"Hello\n\nCongratulations, you are now accepted to ...."
Set the offer letter text (“comments”) to the application offer (identified by it's ID).
PUT /api/applications/123/offers/321/comments Host: apply.example.edu Authorization: DREAM apikey="..."
This will be set as the offer letter text (“comments”) of the application offer in question, upon successful validation.
"Hello\n\nCongratulations, you are now accepted to ...."
Content-Type: text/plain Content-Length: 0
200 OK | Offer letter text/comments were successfully set |
400 Bad Request | Invalid offer letter text/comments. |
404 Not Found | Application does not have this offer |