Offer type

Mon, 01 Jan 0001 00:00:00 +0000

Represents a single offer type.

URI

/api/v9/applications/offers/types/ID

Get an offer type

Retrieve information about an 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`	Media type of the resource
`Content-Length`	`1234`	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
}

Offer types on DreamApply Knowledge Base

Offer type

GET Get an offer type

Example request

Response headers

Response codes

Example response

Get an offer type