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
Last revisionBoth sides next revision
api:api_institutions [2014/06/29 20:34] – [Parameters] Lauri Elevantapi:api_institutions [2019/10/01 12:40] – [Response example] Lauri Elevant
Line 17: Line 17:
 ^ Name ^  ^ Description ^ Notes ^ ^ Name ^  ^ Description ^ Notes ^
 | ''byStatuses'' | Optional | List of statuses, currently limited to: ''Online'', ''Draft'' | [1] | | ''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] | | ''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.//   * // 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 ==== ==== Response headers ====
  
Line 25: Line 27:
   Content-Length: 1456   Content-Length: 1456
   X-Count: 1   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"
 +    }
 +  }