Updates For School API, OneRoster API - January 3

Bob Costanzo
Bob Costanzo Blackbaud Employee
Eighth Anniversary Kudos 1 Participant Blackbaud Staff
in SKY Developer Announcements

Changed

School API

We've consolidated and renamed several objects and properties returned in the response for GET Degrees student degrees by ID (BETA); these are breaking changes that may disrupt current endpoint implementations.

The student_degrees object received the following changes:

  • The user_degree_id property is renamed to id.

  • The degree sub-object is renamed to requirement_set.

The majors, minors, and concentrations sub-objects of student_degrees received the following changes:

  • The major_concentrations sub-object of majors is renamed to concentrations.

  • The area_of_study sub-objects are renamed to requirement_set.

Each requirement_set sub-object is structured as follows:

  • The group_name and group_short_description properties have been removed and are now represented as new sub-objects specific to the parent object:

    • majors.requirement_set now features a major object with the following properties: id, name, and abbreviation.

    • concentrations.requirement_set now features a concentrations object with the following properties: id, name, and abbreviation.

    • minors.requirement_set now features a minor object with the following properties: id, name, and abbreviation.

    • student_degrees.requirement_set now features a degree object with the following properties: id, name, and abbreviation.

Changed

OneRoster API

We've updated the responses for several endpoints to include additional properties.

The endpoints impacted by these changes include:

For each endpoint listed, the following properties are now returned in the responses:

  • givenName

    The Preferred name of the user; If Preferred name is undefined, First name is returned. Preferred name and First name are defined under General information on the Contact Card.

  • middleName

    The middle name of the user. Middle name is defined under General information on the Contact Card.

  • Phone

    The 10-digit (e.g., 6035012002) home phone number of the user; if the home phone number is undefined, the wireless phone number is returned. If both home and wireless phone types are undefined, the value of Phone is an empty string. Phone numbers are defined under Phone on the Contact Card.

  • Sms

    The 10-digit (e.g., 6035012002) wireless phone number of the user; if the wireless number is undefined, the home phone number is returned. If both home and wireless phone types are undefined, the value of Sms is an empty string. Phone numbers are defined under Phone on the Contact Card.

  • Email

    The email address of the user. Email addresses are defined under Digital on the Contact Card.

  • Metadata

    An object that contains a variety of address-related properties, including:

    • address1
    • address2
    • city
    • state
    • stateId
    • postCode
    • phone
    • grade

The address-related metadata fields are defined as the Primary type under Address on the Contact Card. The stateId is defined under the Student section of General information on the Contact Card. The grade property is specific to students or users with the student role.

We've updated the responses for the following endpoints to include additional properties.

The endpoints impacted by these changes include:

We've updated the responses for the following endpoints to include additional properties:

For each endpoint listed, the following properties are now returned in the responses as part of the new metadata object:

  • address1
  • address2
  • city
  • state
  • postCode
  • phone

These properties use the data defined under Schools on the School information page; if the data is unavailable under Schools, the data from Main address is used.

For each endpoint listed, the following properties are now returned in the responses as part of the new metadata object for users with the student role:

  • iepStatus

    The IEP status, if available, as defined under Accommodations on the Contact Card.

  • ellStatus

    The ELL field, if available, as defined under Accommodations on the Contact Card.

  • frlStatus

    The FRL field, if available, as defined under Accommodations on the Contact Card.

Categories