Institution
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 single institution set up in DreamApply.
URI
/api/v9/institutions/IDGET Get an institution
Return information about an institution, identified by the institution’s ID.
Syntax
GET /api/v9/institutions/123
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/institutions/123"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The institution data was successfully returned |
404 Not Found | The institution was not found |
Example response
Response
{
"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/v9/institutions/1/departments"
}