This is an old revision of the document!


/api/applications/ID/offers/ID/comments

HEAD, GET

A request with the GET verb returns the offer letter text (“comments”) for this particular offer (identified by offer ID).

Syntax

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

Response headers

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

Response codes

200 OK The offer letter text (“comments”) was returned successfully
404 Not Found Application does not have this offer

Response example

"Hello\n\nCongratulations, you are now accepted to ...."

PUT

Set the offer letter text (“comments”) to the application offer (identified by it's ID).

Syntax

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

Raw request body

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 ...."

Response headers

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

Response codes

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