meta data for this page
  •  

This is an old revision of the document!


/api/applications/statuses

HEAD, GET

List all application statuses configured for this setup. Note that in the GUI the statuses will be displayed according to their title property. However, when filtering applications by statuses (see /api/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/applications/statuses
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

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

Response example

{
  "Blank": {
      "title": "Blank",
      "colour": "#b7e356",
      "verbose": "The application is not yet filled"
  },
  "Prepare": {
      "title": "Prepare",
      "colour": "#b7e356",
      "verbose": "The application is being prepared"
  },
  "Inactive": {
      "title": "Inactive",
      "colour": "#b7e356",
      "verbose": "The application is being prepared"
  },
  "Completed": {
      "title": "Completed",
      "colour": "#b7e356",
      "verbose": "The application is ready for submitting"
  },
  "Submitted": {
      "title": "Submitted",
      "colour": "#ffd21f",
      "verbose": "The application has been submitted"
  },
  "Resubmitted": {
      "title": "Resubmitted",
      "colour": "#ffd21f",
      "verbose": "The application has been re-submitted"
  },
  "Reopened": {
      "title": "Reopened",
      "colour": "#b7e356",
      "verbose": "The application has been reopened"
  },
  "Closed": {
      "title": "Closed",
      "colour": "#AFAFAF",
      "verbose": "The application is closed"
  }
}