Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
api:api_applications_id [2015/02/12 16:45] – [Response example] Lauri Elevantapi:api_applications_id [2024/02/13 15:49] (current) – [Parameters] Lauri Elevant
Line 10: Line 10:
   Host: apply.example.edu   Host: apply.example.edu
   Authorization: DREAM apikey="..."   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 ==== ==== Response headers ====
Line 65: Line 72:
     "education": [     "education": [
         {         {
-            "type": "SE",+            "level": "SE",
             "course": "",             "course": "",
             "graduation": {             "graduation": {
Line 75: Line 82:
         },         },
         {         {
-            "type": "BA",+            "level": "BA",
             "course": "High School Diploma",             "course": "High School Diploma",
             "graduation": {             "graduation": {
Line 85: Line 92:
         },         },
         {         {
-            "type": "IN",+            "level": "IN",
             "course": "Some other programme",             "course": "Some other programme",
             "graduation": {             "graduation": {
Line 206: Line 213:
     "submitted": null,     "submitted": null,
     "status": "Submitted",     "status": "Submitted",
-    "commence_year": "2013",+    "academic_term": "/api/academic-terms/321",
     "applicant": "/api/applicants/16",     "applicant": "/api/applicants/16",
     "flags": "/api/applications/16/flags",     "flags": "/api/applications/16/flags",