Updates For School API, OneRoster - October 4

Bob Costanzo

School

2022-10-04

New

We've added two new endpoints, GET Admissions statuses and GET Users Enrollments by year (BETA).

GET Admissions statuses returns a collection of admissions statuses; this endpoint pairs well with the recently modified GET Admissions candidates endpoint, which now accepts an optional status_ids parameter to filter the response.

GET User enrollments by year (BETA) returns a collection of users and their enrollments for a single school year based on the required school_year parameter. Note that this endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.

Changed

We've updated GET Admissions candidates and GET Custom fields by role.

GET Admissions candidates now features the following enhancements:

• Now returns candidates for any year.
• Features new optional filters to refine results based on either status_ids or modified_date.
• The response now includes new fields as part of the new decision object, including:
  • decision - object
    • id
    • school_decision
    • type
    • type_id
    • date
    • expire_date
    • comment
    • candidate_response - object
      • id
      • decision
      • type
      • type_id
      • date

As part of the addition of the decision object and accompanying fields, the following fields will be deprecated and no longer function as of 01/01/2023:

• school_decision
• school_decision_type
• candidate_decision
• candidate_decision_type

GET Custom fields by role has been updated to accept the optional filter, field_ids. Field_ids expects a comma-separated list of IDs returned by GET Core Admin Custom Fields and filters the response to only include custom fields with matching IDs.

OneRoster

2022-10-04

New

We've made a handful of enhancements to the OneRoster settings page in Blackbaud Education management, including UX improvements and a new Gradebook options setting that is leveraged by the PUT LineItem endpoint when an assignment is missing a category type.

Read our release notes in the Blackbaud community to learn more about the changes to OneRoster settings.