Updates For School API, OneRoster API - January 10
Published
January 10, 2023
New
OneRoster API
We've added a new gradeRange
property to the metadata
object for responses from the following endpoints: GET Orgs by ID, GET Orgs all, GET School by ID, and GET Schools all.
Regarding GET Orgs by ID and GET Orgs all, only orgs of type school
are impacted by the change.
The value of metadata.gradeRange
includes a comma-separated list of each grade level mapped under OneRoster Integration mappings in Education management.
January 1, 2023
Changed
School API
The following endpoints are deprecated as of January 1, 2023; please adopt the suggested replacement endpoints:
- GET Degrees by User ID (DEPRECATED) > GET Degrees Student Degrees by ID
- GET Dorms (DEPRECATED) > GET Dorms
- GET Dorm residents by dorm (DEPRECATED) > GET Dorms
- Get Legacy List (DEPRECATED) > GET List Single
- GET User Custom Fields single (DEPRECATED) > GET Users Custom Fields single (BETA)
- POST User Custom Field Values Create (DEPRECATED) > POST Users Custom Field Values Create (BETA)
- PATCH User Custom Field Values Update (DEPRECATED) > PATCH Users Custom Field Values Update (BETA)
Calls to deprecated endpoints will produce a 410 Gone
HTTP status code.
News
SKY Developer Announcements
01/13/2023 4:13pm EST
Leave a Comment