Differences

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

--- api:api_institutions [2014/06/29 13:23] – [Parameters] Lauri
+++ api:api_institutions [2024/07/30 11:50] (current) – external edit 127.0.0.1
@@ Line 15: / Line 15: @@
 ==== Parameters ====
-| ''?byStatuses'' | Optional | Comma or space-separated list of statuses, currently limited to: ''Online'', ''Draft'' |
+^ Name ^  ^ Description ^ Notes ^
-| ''?byCountries'' | Optional | Comma or space-separated list of [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country codes]] |
+| ''byStatuses'' | Optional | List of statuses, currently limited to: ''Online'', ''Draft'' | [1] |
+| ''byModes'' | Optional | ''Internal'' (DA user) or ''External'' (not users of DA, partner etc.) | [1] |
+| ''byCountries'' | Optional | List of [[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2|ISO 3166-1 alpha-2 country codes]] | [1] |
+  * // Note [1]: Lists can be either comma or space separated. All list items are combined with logical ''OR'' operators - in other words an institution is considered matching if it matches to any of the values in the list.//
 ==== Response headers ====
@@ Line 22: / Line 26: @@
   Content-Type: application/json
   Content-Length: 1456
-  X-Count: 15
+  X-Count: 1
+==== Response example ====
+  {
+    "1": {
+        "status": "Online",
+        "mode": "Internal",
+        "name": "Sample university",
+        "country": "EE",
+        "location": "Tallinn",
+        "www": null,
+        "erasmus": null,
+        "registration": null,
+        "departments": "/api/institutions/1/departments"
+    }
+  }