Updates For School API, OneRoster API - February 16

Bob Costanzo · February 2023

February 16, 2023

OneRoster API

New

We've added two new endpoints, GET Categories for a class and DELETE Result delete.

GET Categories for a class returns an array of categories, with each category represented as a JSON object. The returned categories correspond to the required class_id path parameter in the request.

DELETE Result delete removes an assignment gradebook grade associated with the id included in a request. DELETE Result delete accepts one required parameter, id, which is the id of the assignment gradebook grade.

Changed

We've added a new classId property to the categories.metadata object in the response for GET Categories all; the classId property only appears if the new and optional filter parameter is included in the request.

The value of categories.metadata.classId in the response equals the classId of the filter provided in the request.

An example of the filter parameter appended to the end of the endpoint URL: ?filter=metadata.classId='990_2421'

February 7, 2023

OneRoster API

New

OneRoster API managers can now configure whether rostering data returned in various responses use the Preferred name, if available, or the First name, always, for user records.

This change applies to data returned in the following endpoints:

The page in Education management featuring this change is found by navigating to Core > Settings > Integration settings > OneRoster Settings > Add/Edit OneRoster Settings > Rostering options.

School API

Additionally, the following endpoints are now accessible by any authorized users to ensure core information is universally available:

This change is accomplished by adding All school as a permissible role for authenticating with the endpoints.