Updates For School API, OneRoster - August 9

Bob Costanzo
Bob Costanzo Blackbaud Employee
Eighth Anniversary Kudos 1 Participant Blackbaud Staff
in SKY Developer Announcements
The Latest Updates for School API and OneRoster API.

School API Updates:

2022-08-09

New

We've added two new endpoints with a focus on returning news; the two new endpoints include:

  • GET Content News Categories

    Returns a list of valid news categories based on the logged-in user's role. Requires the user to have either a student, parent, or faculty role.

  • Get Content News Items

    Returns news items based on the logged-in user's role. Requires the user to have either a student, parent, or faculty role.

Changed

We've changed the names of two endpoints to enhance clarity and conciseness; the endpoint name changes include:

Additionally, the roles parameter, as part of the GET User Custom Fields by role(s) (BETA), is now base_roles_ids.

2022-08-02

New

We've added several new endpoints with a focus on returning custom fields; the new endpoints include:

  • GET Core Admin Fields (BETA)

    Returns a collection of sessions for a higher education institution. Requires the user to have the role of Platform Manager.

  • GET Custom Fields for user by roles(s) (BETA)

    Returns a paginated collection of users with Custom Admin Fields, limited to 100 users per page. Includes both user custom fields and administration view only custom fields. Use the last UserId number as the marker value to return the next set of results. For example, marker=101 will return the second set of results. Requires the user to have the role of Platform manager.

  • GET Custom Admin Fields for a User (BETA)

    Returns both user custom fields and administration view only custom fields. Requires the user to have the role of Platform Manager.

OneRoster API Updates:

2022-08-09

New

We've added a new endpoint, GET Enrollments for a school; this endpoint returns an array of enrollment objects relative to the required school_id parameter.

2022-07-13

New

The initial release of the OneRoster OAuth 2.0 SKY API. For more information, check out the endpoint reference.

Reference our documentation on generating a bearer token to use the new OneRoster OAuth 2.0 endpoints.

Categories