This is an old revision of the document!

/api/applications/ID/offers

HEAD, GET

List all offers that have been generated for the application in question. Use the HEAD verb to see if there are any offers yet. The X-Count header will indicate the number of offers.

An empty (Unreplied) offer is generated automatically for each course on an application when the application is submitted. If the application is subsequently re-submitted and any new courses have been added, these too will receive a corresponding empty offer.

Difference between courses and offers

Courses are under applicant control and essentially indicate the choice that an applicant has made. An offer, however, is something that is under the control of the institution being applied to. An offer is essentially used to manage the reply given to an applicant. Thus it only becomes relevant after an application has been submitted when a corresponding offer is generated for each course.

Syntax

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

Response headers

Content-Type: application/json
Content-Length: 1234
X-Count: 15

Response example

{
  "12": {
      "priority": 1,
      "inserted": "2014-06-20T11:00:19+00:00",
      "saved": "2014-06-20T11:00:19+00:00",
      "confirmed": null,
      "course": "/api/courses/1",
      "type": "Feedback",
      "type-confirmed": "Unreplied",
      "comments": null,
      "comments-confirmed": null,
      "decision": "None",
      "decision-policy": "None",
      "decision-deadline": null,
      "notes": null
  },
  "13": {
      "priority": 2,
      "inserted": "2014-06-20T11:00:19+00:00",
      "saved": "2014-06-20T11:00:19+00:00",
      "confirmed": "2014-06-20T11:00:19+00:00",
      "course": "/api/courses/3",
      "type": "Unreplied",
      "type-confirmed": "Accepted",
      "comments": null,
      "comments-confirmed": null,
      "decision": "Final",
      "decision-policy": "None",
      "decision-deadline": null,
      "notes": null
  }
}