Skip to main content

Aeries OneRoster API Sync

This guide walks through the Aeries OneRoster API sync.

Written by Jareena

This guide walks through the Aeries OneRoster API sync. If you operate a different SIS, please note the following information is needed to integrate.

At minimum, you will enable read permissions to the following items in the OneRoster API:

  • Student Data / Student Data

  • School Information / Schools

  • School Information / Terms

  • Scheduling / Teacher Data

  • Scheduling / Master Schedule

  • Scheduling / Course Data

  • Scheduling / Classes

You’ll enter the following information from your OneRoster API connection into the TadHealth Superuser Portal. You can save it and test the connection immediately.

  • OneRoster base URL *

  • Consumer ID

  • Consumer Secret Key (if applicable)

Please Note: If you're using Infinite Campus, please remove /ims/oneroster/v1p1 from the base URL when copying. TadHealth will automatically append this when we make configure API.

Aeries: Configuring OneRoster for TadHealth

1) Login to Aeries.

2) In the left-hand sidebar, in the Pages tab, search for School Options and select it.

3) Scroll through the options to find “OneRoster Settings”.

4) Click on the “Enable” checkbox to turn on OneRoster.

Note: This will require a full reset of Aeries and will terminate all user sessions. It is recommended to take this action after working hours.

5) Once that has been enabled and the reset has finished, or if it was already enabled, navigate to Security > API Security in the left-hand navigation panel.

6) Click “Add New Vendor/Product”.

7) In the Product Information section, enter the following:

  • Product Name: TadHealth

  • Type: OneRoster

8) Click “Insert”.

9) In the Permissions section, add Read access to the following Program Areas:

  • Student Data / Student Data

  • School Information / Schools

  • School Information / Terms

  • Scheduling / Teacher Data

  • Scheduling / Master Schedule

  • Scheduling / Course Data

  • Scheduling / Classes

10) Select the checkbox to “Display Consumer ID & Secret Keys for OneRoster”. Make note of the OneRoster URL, Consumer ID, and Consumer Secret Key values. You will enter these in the TadHealth.

You can now enter this information into the TadHealth SuperAdmin page at: https://[shortcode].tadhealth.app/super

If you need your custom URL and credentials, please reach out to TadHealth for assistance.

Did this answer your question?