Differences

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

--- api:api_applications_id [2019/11/28 12:50] – Lauri
+++ api:api_applications_id [2024/07/30 11:50] (current) – external edit 127.0.0.1
@@ Line 10: / Line 10: @@
   Host: apply.example.edu
   Authorization: DREAM apikey="..."
+==== Parameters ====
+^ Name ^  ^ Description ^ Notes ^
+| ''expand'' | Optional | Expand the chosen relational element(s), for example ''applicant,offer''  | [4] |
+  * // Note [1]: Some elements in the returned objects are links to other API calls. Using the ''expand'' parameter, it is possible to expand this data to the actual records, saving additional API calls. The full list of possible expansions is ''applicant,flags,courses,offers,documents,tasks,scores''. You can set one or multiple expansions, combining them in a comma-separated fashion to the ''expand'' parameter.//
 ==== Response headers ====
@@ Line 212: / Line 219: @@
     "offers": "/api/applications/16/offers",
     "exports": "/api/applications/16/exports",
-    "documents": "/api/applications/16/documents",
+    "documents": "/api/applications/16/documents"
-    "studyplans": "/api/applications/16/studyplans"
   }