Updates for School API, OneRoster API - November 15

Bob Costanzo

OneRoster

November

2022-11-15

We've included a collection of agent objects in the responses from our GET Users (by ID) and GET Students (by ID, for a School) endpoints; the agent object populates for users with the student entity with each relationship when either Parental Access or List as Parent is marked true.

The agent object is now part of the following endpoint responses:

• GET Student by ID
• GET Students
• GET Students for a School
• GET User by ID
• GET Users

The agents collection is structured as follows:

<span>"agents"</span><span>:</span> <span>[</span><br/>  <span>{</span><br/>    <span>"sourcedId"</span><span>:</span> sourceID of the parent<span>,</span><br/>    <span>"href"</span><span>:</span> href of the parent<span>,</span><br/>    <span>"type"</span><span>:</span> <span>"user"</span><br/>  <span>}</span><br/><span>]</span>

School

November

2022-11-08

We've standardized the routes for our Users Custom Fields endpoints and tweaked their names, specifically including:

• GET admin custom fields is renamed to GET Core custom fields.
• GET User Custom Fields by Role(s) is renamed to GET Users Custom Fields by role(s).
  
• GET User Custom Fields single is now scheduled to be deprecated as of 2023-01-01, and requests currently redirect to the new replacement endpoint, GET Users Custom Fields single (BETA) .
• POST User Custom Field Values Create is scheduled to be deprecated as of 2023-01-01. and requests currently redirect to the new replacement endpoint, POST Users Custom Field Values Create (BETA) .
• PATCH User Custom Field Values Update is scheduled to be deprecated as of 2023-01-01, and requests currently redirect to the new replacement endpoint, PATCH Users Custom Field Values Update (BETA) .

Each of the above endpoints now accepts SKY API Data Sync as a permissible role.