/api/applications/offers/types

HEAD, GET

List all offer types configured for this setup.

Note that in the GUI they will be displayed according to their title property (see the “Browse” menu). However, when filtering applications by offer types (see /api/applications) you must use the actual type names, not their title property. In many cases, they overlap, but this cannot be guaranteed to be so.

Syntax

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

Response headers

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

Response example

API version >= 4
{
  "1": {
      "id": 1,
      "title": "Unreplied",
      "colour": "#ffd21f",
      "ranking": "Pending",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": null,
      "decline": null,
      "reopen": null,
      "silence": null,
      "subject": "Reply Unreplied from Sample site",
      "comments": "Dear %applicant-Name%,\n\n\n\n\n\n\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
    "7": {
      "id": 7,
      "title": "Feedback",
      "colour": "#ff5599",
      "ranking": "Pending",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": null,
      "decline": null,
      "reopen": null,
      "silence": null,
      "subject": "Reply Feedback from Sample site",
      "comments": "Dear %applicant-Name%,\n\nYou have received feedback from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
  "8": {
      "id": 8,
      "title": "Positive feedback",
      "colour": "#ff5599",
      "ranking": "Pending",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": null,
      "decline": null,
      "reopen": null,
      "silence": null,
      "subject": "Reply Positive feedback from Sample site",
      "comments": "Dear %applicant-Name%,\n\nYou have received positive feedback from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
  "18": {
      "id": 18,
      "title": "Conditionally accepted",
      "colour": "#97c4d9",
      "ranking": "In quota",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": 1,
      "decline": 1,
      "reopen": null,
      "silence": null,
      "subject": "Reply Conditionally accepted from Sample site",
      "comments": "Dear %applicant-Name%,\n\nYou have received a conditionally accepted offer from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
  "20": {
      "id": 20,
      "title": "Accepted",
      "colour": "#97c4d9",
      "ranking": "In quota",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": 1,
      "decline": 1,
      "reopen": null,
      "silence": null,
      "subject": "Reply Accepted from Sample site",
      "comments": "Dear %applicant-Name%,\n\nYou have received an accepted offer from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
  "22": {
      "id": 22,
      "title": "Failed",
      "colour": "#e53828",
      "ranking": "Eliminated",
      "bcc": [],
      "confirm": 1,
      "freeze": null,
      "decide": null,
      "decline": null,
      "reopen": null,
      "silence": null,
      "subject": "Reply Failed from Sample site",
      "comments": "Dear %applicant-Name%,\n\nYour application to %institution-Name% regarding %course-FullName% has been rejected.\n\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
  },
  ...
  ...
  ...
}
API version <= 3
{
  "Unreplied": {
      "id": 1,
      "title": "Unreplied",
      "colour": "#ffd21f"
  },
  "Feedback": {
      "id": 7,
      "title": "Feedback",
      "colour": "#ff5599"
  },
  "Positive feedback": {
      "id": 8,
      "title": "Positive feedback",
      "colour": "#ff5599"
  },
  "Conditionally accepted": {
      "id": 18,
      "title": "Conditionally accepted",
      "colour": "#97c4d9"
  },
  "Accepted": {
      "id": 20,
      "title": "Accepted",
      "colour": "#97c4d9"
  },
  "Failed": {
      "id": 22,
      "title": "Failed",
      "colour": "#e53828"
  },
  ...
  ...
  ...
}