Differences

This shows you the differences between two versions of the page.

--- api:api_intakes [2014/06/30 17:56] – created Lauri
+++ api:api_intakes [2024/07/30 11:50] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 ===== HEAD, GET =====
-List all intakes that have been configured in the system. Knowing the intake ID-s may be useful for [[api:api_applications|filtering applications]]. For example, you may want to filter out applications by Autumn intake only.
+List all intakes that have been configured in the system. Knowing the intake ID-s may be useful for [[api:api_applications|filtering applications]].
+A course can be offered under several intakes (Winter, Autumn etc.) with each intake governing the application period, deadlines and other policies.
+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''.
+FIXME Explain the data structure further
 ==== Syntax ====
@@ Line 16: / Line 21: @@
   Content-Type: application/json
   Content-Length: 1234
+==== Response example ====
+  {
+    "1": {
+        "name": "Default intake",
+        "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"
+    }
+  }