Offer type
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 a single offer type.
URI
/api/v9/applications/offers/types/IDGET Get an offer type
Retrieve information about a specific offer type.
This request is supported in API version 4 and later.
Syntax
GET /api/v9/applications/offers/types/123
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/offers/types/123"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The offer type data was successfully returned |
404 Not Found | The offer type was not found |
Example response
Response
{
"id": 123,
"status": "Online",
"title": "Feedback",
"colour": "#FF5599",
"ranking": "Pending",
"bcc": [],
"confirm": 1,
"freeze": null,
"decide": null,
"decline": null,
"reopen": null,
"silence": null,
"subject": "Reply Feedback",
"comments": "Dear %applicant-Name%,\n\nYou have received feedback from %institution-Name% regarding %course-FullName%\n\nPlease do not reply to this message.",
"reasons": null
}