Districts that are setting up OneRoster API connections from SISs will need to share their API credentials with the SchooLinks team in a secure manner (secure email or upload to our shared SFTP server) and provide authentication methodology details to SchooLinks.

Our team has supported and is familiar with the idiosyncrasies of OneRoster API endpoints from Infinite Campus, Skyward, eSchoolPlus, Aeries, and many other SISs.

To setup the OneRoster syncs we will need the following information:

1. Connection info

• API URL or hostname
• Token endpoint
• authentication credentials (please provide securely to SchooLinks → via phone or encrypted email)
  • API key / client_id
  • API Secret / client_secret

2. Filter info

• Which user types should be synced:

  • student
  • staff
  • guardian/parent

• Which student grades should be synced

• Student primary identifier — if you are syncing more than one primary identifier for students, we need to know which primary identifier you will be using to sync all of the other files

  Our team will cross reference the filtering info with the scope of users included in your contract before setup.

<aside> 👉

We require you to share demographics data with us because it contains student DOB, a required field in our data model (needed for fuzzy student matching, transcript network sending)

</aside>

Metadata fields

Common use cases for metadata fields for different user types include:

• Staff
  • access_type (one of District, School or section-only)
  • schoolinks_role (exact name string match to SchooLinks Preset or Custom district roles)
• Students
  • original_expected_graduation_year (what people think of as students “cohort”)