Departments
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 departments under the institution.
URI
/api/v9/institutions/ID/departmentsGET List departments
List all departments under the institution in question.
Syntax
GET /api/v9/institutions/123/departments
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/departments"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
X-Count | 3 | Number of departments under this institution |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of departments was successfully returned |
Example response
Response
{
"1": {
"id": 1,
"name": "Department of Computer Science and Engineering",
"country": "BE",
"location": "Antwerp",
"www": "https://engtech.edu/cs"
},
"2": {
"id": 2,
"name": "Department of Electrical and Electronics Engineering",
"country": "BE",
"location": "Antwerp",
"www": "https://engtech.edu/ee"
},
"3": {
"id": 3,
"name": "Department of Industrial and Systems Engineering",
"country": "BE",
"location": "Antwerp",
"www": "https://engtech.edu/ise"
}
}