Application statuses

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

Represents a list of all application statuses.

URI
/api/v9/applications/statuses

List application statuses

List all application statuses configured for this setup.

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

Syntax
GET /api/v9/applications/statuses
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/statuses"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes
`X-Count`	`7`	Number of available application statuses

Response codes

Response code	Description
`200 OK`	The list of application statuses was successfully returned

Example response

Response
{
  "Blank": {
    "title": "Blank",
    "colour": "#B7E356",
    "verbose": "The application is empty"
  },
  "Draft": {
    "title": "Draft",
    "colour": "#B7E356",
    "verbose": "The application is still a draft"
  },
  "Inactive": {
    "title": "Inactive",
    "colour": "#B7E356",
    "verbose": "The application is still a draft, but apparently not being worked on"
  },
  "Reopened": {
    "title": "Reopened",
    "colour": "#B7E356",
    "verbose": "The application has been reopened"
  },
  "Submitted": {
    "title": "Submitted",
    "colour": "#FFD21F",
    "verbose": "The application has been submitted"
  },
  "Withdrawn": {
    "title": "Withdrawn",
    "colour": "#AFAFAF",
    "verbose": "The application is withdrawn"
  },
  "Closed": {
    "title": "Closed",
    "colour": "#AFAFAF",
    "verbose": "The application is closed"
  }
}

Flags (global)

Offer types