Offer types

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of all offer types.

URI
/api/v10/applications/offers/types

List offer types

List all offer types configured for your instance.

In Browse view of the DreamApply portal, offer type names are displayed according to their title property. However, when filtering applications by offer type using GET /api/v10/applications), you must use the actual offer type IDs rather than their title property.

Syntax
GET /api/v10/applications/offers/types
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/v10/applications/offers/types"

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
`X-Count`	`10`	The number of available offer types

Response codes

Response code	Description
`200 OK`	The list of offer types was successfully returned

Example response

Response
{
  "1": {
    "id": 1,
    "status": "Online",
    "title": "Unreplied",
    "colour": "#FFD21F",
    "ranking": "Pending",
    "bcc": [],
    "confirm": 1,
    "freeze": null,
    "decide": null,
    "decline": null,
    "reopen": null,
    "silence": null,
    "subject": "Reply Unreplied from Institute of Technology",
    "comments": "Dear %applicant-Name%,\n\Institute of Technology\n\\nPlease do not reply to this message.",
    "reasons": null
  },
  "2": {
    "id": 2,
    "status": "Online",
    "title": "Nominated",
    "colour": "#97C4D9",
    "ranking": "Pending",
    "bcc": [],
    "confirm": null,
    "freeze": null,
    "decide": null,
    "decline": null,
    "reopen": null,
    "silence": null,
    "subject": "Reply Nominated from Institute of Technology",
    "comments": "Dear %applicant-Name%,\n\nYou have received a nomination regarding %course-FullName%\n\n\n\nInstitute of Technology\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message.",
    "reasons": null
  },
  "10": {
    "id": 10,
    "status": "Online",
    "title": "Failed",
    "colour": "#E53828",
    "ranking": "Eliminated",
    "bcc": [],
    "confirm": 1,
    "freeze": null,
    "decide": null,
    "decline": null,
    "reopen": null,
    "silence": null,
    "subject": "Reply Failed from Institute of Technology",
    "comments": "Dear %applicant-Name%,\n\nYour application to %institution-Name% regarding %course-FullName% has been rejected.\n\n\n\n\nInstitute of Technology\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message.",
    "reasons": {
      "1": {
        "id": 1,
        "reason": "Documents missing"
      },
      "2": {
        "id": 2,
        "reason": "Failed technical check"
      },
      "3": {
        "id": 3,
        "reason": "Scores too low"
      },
      "4": {
        "id": 4,
        "reason": "Interview insufficient"
      },
      "5": {
        "id": 5,
        "reason": "Study places full"
      },
      "6": {
        "id": 6,
        "reason": "Other reason"
      }
    }
  }
}

Response
{
  "Unreplied": {
    "id": 1,
    "status": "Online",
    "title": "Unreplied",
    "colour": "#ffd21f",
    "reasons": null
  },
  "Nominated": {
    "id": 2,
    "status": "Online",
    "title": "Nominated",
    "colour": "#97c4d9",
    "reasons": null
  },
  "Feedback": {
    "id": 3,
    "status": "Online",
    "title": "Feedback",
    "colour": "#ff5599",
    "reasons": null
  },
  "Positive feedback": {
    "id": 4,
    "status": "Online",
    "title": "Positive feedback",
    "colour": "#ff5599",
    "reasons": null
  },
  "Conditionally accepted": {
    "id": 5,
    "status": "Online",
    "title": "Conditionally accepted",
    "colour": "#97c4d9",
    "reasons": null
  },
  "Accepted": {
    "id": 6,
    "status": "Online",
    "title": "Accepted",
    "colour": "#97C4D9",
    "reasons": null
  },
  "Failed": {
    "id": 7,
    "status": "Online",
    "title": "Failed",
    "colour": "#e53828",
    "reasons": {
      "1": {
        "id": 1,
        "reason": "Documents missing"
      },
      "2": {
        "id": 2,
        "reason": "Failed technical check"
      },
      "3": {
        "id": 3,
        "reason": "Scores too low"
      },
      "4": {
        "id": 4,
        "reason": "Interview insufficient"
      },
      "5": {
        "id": 5,
        "reason": "Study places full"
      },
      "6": {
        "id": 6,
        "reason": "Other reason"
      }
    }
  },
  "Other": {
    "id": 8,
    "status": "Online",
    "title": "Other",
    "colour": "#afafaf",
    "reasons": null
  }
}