Institutions
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of institutions set up for the DreamApply instance.
URI
/api/v10/institutionsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v10/institutions | C | GET HEAD | List all institutions that match the specified filters |
/api/v10/institutions/ID | R | GET HEAD | Get an institution |
/api/v10/institutions/ID/ | C | GET HEAD | List all departments under an institution |
/api/v10/institutions/ID/ | R | GET HEAD | Get a department under an institution |
GET List institutions
List institutions that match the specified filter parameters. The number of institutions is returned in the X-Count header.
In most use cases, there will only be one institution in the system. However, in exchange management setups as well as collaborative systems there may be several institutions.
Syntax
GET /api/v10/institutions
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Parameter | Required/Optional | Description | Notes |
|---|---|---|---|
byStatuses | Optional | A list of statuses, currently limited to: Online, Draft. | [1] |
byModes | Optional | The institution mode. Allowed values: Internal (DreamApply user) or External (not users of DreamApply, partners and so on). | [1] |
byCountries | Optional | A list of ISO 3166-1 alpha-2 country codes. | [1] |
Notes
Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators, meaning an institution is included if it matches any value in the list.
Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/institutions?byStatuses=Online"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
X-Count | 3 | The number of registered institutions |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of institutions was successfully returned |
Example response
Response
{
"1": {
"id": 1,
"status": "Online",
"name": "School of Engineering and Technology",
"country": "BE",
"location": "Antwerp",
"www": "https://engtech.edu",
"erasmus": "BE ANTWERP08",
"address": "15 De Keyserlei\r\n2000 Antwerp",
"vat": "BE0471123456",
"iban": "BE68 5390 0754 7034",
"registration": null,
"departments": "/api/v10/institutions/1/departments"
},
"2": {
"id": 2,
"status": "Online",
"name": "School of Chemistry",
"country": "BE",
"location": "Antwerp",
"www": "https://dreamapply.com/",
"erasmus": null,
"address": "15 De Keyserlei\r\n2000 Antwerp",
"vat": null,
"iban": null,
"registration": null,
"departments": "/api/v10/institutions/2/departments"
},
"3": {
"id": 3,
"status": "Online",
"name": "School of Applied Science",
"country": "BE",
"location": "Antwerp",
"www": "https://dreamapply.com/",
"erasmus": null,
"address": "15 De Keyserlei\r\n2000 Antwerp",
"vat": null,
"iban": null,
"registration": null,
"departments": "/api/v10/institutions/3/departments"
}
}