Offer subject
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 subject line of the application offer.
URI
/api/v9/applications/ID/offers/ID/subjectGET Get the offer subject
A request with the GET verb returns the offer letter subject line.
Syntax
GET /api/v9/applications/123/offers/321/subject
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/v9/applications/123/offers/321/subject"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 offer letter subject line was successfully returned |
404 Not Found | The application does not have this offer |
Example response
Response
"You are accepted to a study place"PUT Set the offer subject
Set the offer letter subject line to the application offer (identified by its ID).
Syntax
PUT /api/v9/applications/123/offers/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
This will be set as the type of the application offer in question, upon successful validation.
Request body
"Congratulations, you are accepted"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Congratulations, you are accepted"' \
"https://apply.example.edu/api/v9/applications/123/offers/321/subject"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 code | Description |
|---|---|
200 OK | The subject was successfully set |
400 Bad Request | Invalid offer subject line |
404 Not Found | The application does not have this offer |