meta data for this page
  •  

This is an old revision of the document!


/api/intakes/ID

HEAD, GET

List the details of the intake in question.

All dates (for example deadlines) are configured using ISO date notation, but skipping the year part as the intake system is designed to automatically roll over to the next year when appropriate. For this reason, dates are normally specified as 0000-MM-DD, for example 0000-04-23.

Syntax

GET /api/intakes/ID
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

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

Response example

{
   "start": "0000-09-01",
   "pre": {
       "deadline": null,
       "info": null,
       "mask": false
   },
   "policy": "Flexible",
   "deadlines": {
       "001": {
           "deadline": "0000-05-01",
           "info": null
       }
   },
   "decision": {
       "policy": "Advisory",
       "days": "7"
   },
   "arrival": "0000-09-01",
   "commence": "0000-09-15",
   "name": {
       "scheme": "Commence season",
       "custom": ""
   },
   "notes": "Default intake"
}