Get Academic Years
Data in the ASSIST system is versioned to each Academic Year and in some cases Term. This means that with each new Academic Year, or even Term, the potential exists for the data you are working with to change.
The Get Academic Years API provides a list of active Academic Years in the system. This provides a list of Academic Years (and their Ids) that can be used to access data in other APIs. When an API requires a parameter named academicYearId
it will be referring to the id
value from a result in this API.
Api
- Route
/academicyears/api
- Method
- GET
- Key Required
- No
- Common Response
- No
- Response Type
- Array of Academic Year
Sample Response
[
{
"id": 75,
"code": "2024-2025",
"beginDate": "2024-10-01T00:00:00",
"endDate": "2025-10-01T00:00:00",
"isOpenForMaintenance": true,
"isOpenForPublic": true,
"isOpenForReporting": true
},
{
"id": 74,
"code": "2023-2024",
"beginDate": "2023-10-01T00:00:00",
"endDate": "2024-10-01T00:00:00",
"isOpenForMaintenance": true,
"isOpenForPublic": true,
"isOpenForReporting": true
},
{
"id": 73,
"code": "2022-2023",
"beginDate": "2022-10-01T00:00:00",
"endDate": "2023-10-01T00:00:00",
"isOpenForMaintenance": true,
"isOpenForPublic": true,
"isOpenForReporting": true
}
]
Academic Year Model
- id (int)
- Represents the Academic Year’s unique ID. Use this value with other APIs that require
academicYearId
parameter - code (string)
- A display value representation of the academic year
- beginDate (date)
- The date at which the academic year begins
- endDate (date)
- The data at which the academic year ends
Other fields included in these results can be ignored for purposes of use with other APIs.
Curl
curl -X GET --header 'Accept: application/json' 'https://prod.assistng.org/AcademicYears/api'