Differences

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

--- api:api_applications_offers_types [2014/06/30 15:46] – created Lauri Elevant
+++ api:api_applications_offers_types [2024/01/15 11:53] (current) – [Response example] Safak Samiloglu
@@ Line 1: / Line 1: @@
-====== /api/offers/types ======
+====== /api/applications/offers/types ======
 ===== HEAD, GET =====
@@ Line 18: / Line 18: @@
   Content-Length: 1234
-==== Response example ====
+ ==== Response example ====
+== API version >= 4 ==
   {
-    "Nominated": {
+    "1": {
-        "title": "Nominated",
+        "id": 1,
-        "colour": "#f09e1d"
+        "title": "Unreplied",
+        "colour": "#ffd21f",
+        "ranking": "Pending",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": null,
+        "decline": null,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Unreplied from Sample site",
+        "comments": "Dear %applicant-Name%,\n\n\n\n\n\n\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+      "7": {
+        "id": 7,
+        "title": "Feedback",
+        "colour": "#ff5599",
+        "ranking": "Pending",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": null,
+        "decline": null,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Feedback from Sample site",
+        "comments": "Dear %applicant-Name%,\n\nYou have received feedback from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+    "8": {
+        "id": 8,
+        "title": "Positive feedback",
+        "colour": "#ff5599",
+        "ranking": "Pending",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": null,
+        "decline": null,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Positive feedback from Sample site",
+        "comments": "Dear %applicant-Name%,\n\nYou have received positive feedback from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+    "18": {
+        "id": 18,
+        "title": "Conditionally accepted",
+        "colour": "#97c4d9",
+        "ranking": "In quota",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": 1,
+        "decline": 1,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Conditionally accepted from Sample site",
+        "comments": "Dear %applicant-Name%,\n\nYou have received a conditionally accepted offer from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+    "20": {
+        "id": 20,
+        "title": "Accepted",
+        "colour": "#97c4d9",
+        "ranking": "In quota",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": 1,
+        "decline": 1,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Accepted from Sample site",
+        "comments": "Dear %applicant-Name%,\n\nYou have received an accepted offer from %institution-Name% regarding %course-FullName%\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+    "22": {
+        "id": 22,
+        "title": "Failed",
+        "colour": "#e53828",
+        "ranking": "Eliminated",
+        "bcc": [],
+        "confirm": 1,
+        "freeze": null,
+        "decide": null,
+        "decline": null,
+        "reopen": null,
+        "silence": null,
+        "subject": "Reply Failed from Sample site",
+        "comments": "Dear %applicant-Name%,\n\nYour application to %institution-Name% regarding %course-FullName% has been rejected.\n\n\n\n\nSample site\n\n\n\n- - - - - - - - - - - -\nPlease do not reply to this message."
+    },
+    ...
+    ...
+    ...
+  }
+== API version <= 3 ==
+  {
+    "Unreplied": {
+        "id": 1,
+        "title": "Unreplied",
+        "colour": "#ffd21f"
     },
     "Feedback": {
+        "id": 7,
         "title": "Feedback",
         "colour": "#ff5599"
     },
     "Positive feedback": {
+        "id": 8,
         "title": "Positive feedback",
         "colour": "#ff5599"
     },
     "Conditionally accepted": {
+        "id": 18,
         "title": "Conditionally accepted",
         "colour": "#97c4d9"
     },
     "Accepted": {
+        "id": 20,
         "title": "Accepted",
         "colour": "#97c4d9"
     },
     "Failed": {
+        "id": 22,
         "title": "Failed",
         "colour": "#e53828"
     },
-    "Other": {
+    ...
-        "title": "Other",
+    ...
-        "colour": "#AFAFAF"
+    ...
-    },
-    "Enrolled": {
-        "title": "Enrolled",
-        "colour": "#B866FF"
-    },
-    "Arrived": {
-        "title": "Arrived",
-        "colour": "#ffd21f"
-    }
   }