Academic years
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 all academic years.
URI
/api/v9/academic-yearsView all API request
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/academic-years | C | GET, HEAD | Get a list of all configured academic years |
/api/v9/academic-years/year | R | GET, HEAD | Get information about an academic year |
GET List academic years
List academic years configured into the system. These in turn academic terms.
An academic year does not have to align with the calendar year, so it may also have a name like 2017/18 when it spans, for instance, from September to September.
Syntax
GET /api/v9/academic-years
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/academic-years"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 | 4 | Number of configured academic years |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of years was successfully returned |
Example response
Response
{
"2023": {
"name": "2023/24",
"start": "2023-09-01"
},
"2024": {
"name": "2024/25",
"start": "2024-09-01"
},
"2025": {
"name": "2025/26",
"start": "2025-09-01"
},
"2026": {
"name": "2026/27",
"start": "2026-09-01"
}
}