Training
Learning path
School Data Sync advanced for education partners - Training
Education partners learn how to implement School Data Sync for education customers. Part of the Partner Success Series.
This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
OneRoster API (Application Programming Interfaces) is an Industry Standard format, from 1EdTech (formerly IMS Global), for exchange of Student Information System (SIS) / Student Management Systems (SMS) data. Using this sync method, you can connect directly to your SIS/SMS using the REST-based OneRoster 1.1 APIs developed by your SIS/SMS provider. The API support allows you to synchronize data directly instead of using CSV (Comma Separated Value) files.
Using the OneRoster API to ingest the data enables you to light up core SDS capabilities for provisioning. It also allows you to enhance experiences of the Microsoft 365 products and features. The OneRoster APIs are how we can synchronize objects from SIS/SMS that provides OneRoster APIs through the School Data Sync (SDS) platform.
For more information on how to set up your tenant to use OneRoster API as a source, Data Ingestion with OneRoster API.
Provider name | SDS (Classic) status | SDS status | Supports contacts | Supports demographics | Supports user flags |
---|---|---|---|---|---|
Aequitas Q | Yes | Yes | Yes | Yes | No |
Aeries | Yes | Yes | No | No | No |
Arbor Education | Yes | Yes | No | No | No |
Blackbaud Education Management | Yes | Yes | Yes | Yes | No |
Bubblecon | No | Yes | No | No | No |
ClassLink | Yes | Yes | No | No | No |
Classter | Yes | Yes | No | No | No |
CloudClass | No | Test | No | No | No |
Edge Learning | Yes | Yes | No | No | No |
Educate by Community Brands | Yes | Yes | No | No | No |
Edulife Connect | Yes | Yes | No | No | No |
eSchoolData | Yes | Yes | No | No | No |
eSchooling | Yes | Yes | No | No | No |
Eum School SIS | No | Yes | Yes | Yes | No |
Eventful | Yes | Yes | Yes | No | No |
FACTS | Yes | Yes | No | No | No |
Focus School Software | Yes | Yes | No | No | No |
Follett Aspen | Test | Test | No | No | No |
Fujitsu | No | Test | No | No | No |
Furlong Schoolbase | Yes | Yes | Yes | No | No |
INACAP API SDS | Test | Test | No | No | No |
Infinitas Learning | Test | Test | No | No | No |
Infinite Campus | Yes | Yes | No | No | No |
InLogic | Yes | Yes | No | No | No |
iSAMS | Yes | Yes | No | No | No |
IST | Yes | Yes | No | No | No |
Librus | Yes | Yes | No | No | No |
Michigan Data Hub | Test | Test | No | No | No |
MySchool](#myschool) | Yes | Yes | No | No | No |
Nexquare | Yes | Yes | No | No | No |
NordicCloud | Test | Yes | No | No | No |
Realtime | Test | Test | No | No | No |
Rediker Software | Yes | Yes | No | No | No |
SIMS | Yes | Yes | No | No | No |
Sentral | Test | Yes | No | No | No |
Skool | Yes | Yes | No | No | No |
Skyward | Yes | Yes | No | Yes | No |
SmartSchool | Yes | Yes | No | No | No |
Sycamore School | Test | Test | No | No | No |
Synergy SIS | Yes | Yes | Yes | Yes | No |
Trivium | Yes | Yes | No | No | No |
Veracross | Test | Yes | No | No | No |
Vigilo | Yes | Yes | No | No | No |
Visma InSchool | Test | Yes | No | No | No |
VULCAN UONET+ | Yes | Yes | No | No | No |
Zuria | No | Test | Yes | Yes | No |
My provider is not listed in the dropdown and the status here says Test. What do I need to do to see them in the provider list?
Reach out to the Customer support team to flight your tenant and gain access to the API providers currently Test. Share following information when raising the request:
Once your tenant is flighted, work with your OneRoster provider, and SDS POC to run tests and ensure that the integration is successful. If you run into any issue, work with the provider and SDS POC to get them resolved.
Once the test is successful, the OneRoster Provider status is updated (from test mode to yes) and available on list of publicly accessible providers for all tenants.
My provider is not listed. Is there information to share with them to participate as a OneRoster provider with SDS?
What endpoints are being accessed when ingesting roster data?
Required API Endpoints for SDS
Action | URL | Required Filter Properties | Optional / Recommended Filter | Examples |
---|---|---|---|---|
GetAllAcademicSessions | /academicSessions | status | dateLastModified | /academicSessions?offset=0&limit=5000&filter=status=’active’/academicSessions?filter=dateLastModified>’{deltaDateTime}' |
GetAllOrgs | /orgs | status | dateLastModified | /orgs?offset=0&limit=5000&filter=status=’active’/orgs?filter=dateLastModified>’{deltaDateTime}’ |
GetAllUsers | /users | status | dateLastModified | /users?offset=0&limit=5000&filter=status=’active’/users?filter=dateLastModified>’{deltaDateTime}’ |
GetAllClasses | /classes | status | dateLastModified | /classes?offset=0&limit=5000&filter=status=’active’/classes?filter=dateLastModified>’{deltaDateTime}’ |
GetAllEnrollments | /enrollments | status | dateLastModified | /enrollments?offset=0&limit=5000&filter=status=’active’/enrollments?filter=dateLastModified>’{deltaDateTime}’ |
Optional API Endpoints for SDS
Note
For the optional pieces of data for demographics, student contact relationships and student user flags, the ability for you to include this data or not will be based on the supported optional data capabilities from your SIS/SMS OneRoster provider profile. If the SIS/SMS Provider also supports this data, you will see the toggle (default) selected On to include additional data. You can select the toggle to turn off if you wish. If the toggle is unavailable, shown but off and not available for interaction, this means that the provider’s profile does not currently support providing that data.
Note
If the provider’s profile shows demographics, contacts or user demographic flags as unavailable and you would like them to support that feature, contact your provider and request adding support to enable SDS to ingest the data and allow you to enable the scenarios and experiences the data supports.
Action | URL | Required Filter Properties | Optional / Recommended Filter | Examples |
---|---|---|---|---|
GetAllCourses | /courses | status | dateLastModified | /courses?offset=0&limit=5000&filter=status=’active’/courses?filter=dateLastModified>’{deltaDateTime}’ |
GetAllDemographics | /demographics | status | dateLastModified | /demographics?offset=0&limit=5000&filter=status=’active’/demographics?filter=dateLastModified>’{deltaDateTime}’ |
Optional user student contact relationships
Student contact relationship may be specified for student users to enhance educator experiences for communication to parents and guardians. Contacts are more users that are supplied with the /users and association to a student are found in the student’s user record under ‘agents’.
For more information, see the supported student contact relationship roles supported by SDS see Default List of Values: Contact Relationship Roles.
familyName, givenName, and email are required for users that have contact/guardian roles.
Expect phone and sms to be in E.164 and + must be included. (Example: +1234567890)
If reverse data is provided, from a contact relationship guardian record to student in the contact users ‘agents’ field, these records are filtered out.
Optional user demographics flags
User flags may be specified for student users to indicate their participation in a program or cohort. User flags are included (when true for the user), or not included if not applicable.
Flags are specified as a metadata extension for the user, in a metadata field, following a Key|Value pair. The key should be named microsoft.userFlags and must be formatted as a comma delimited list. User flags may appear in any order and aren't case sensitive.
For more information, see the default list of user flag values supported by SDS see Default List of Values: User Flags.
Example:
{
"user" : {
…
…
"metadata" : {
"microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“
}
}
Important
Per 1EdTech it is the responsibility of the provider to enforce data privacy for what data is available when a data request is made. School Data Sync make a request for active data based on the time of the request.
To enable the connection to the OneRoster API for your SIS/SMS, you need to provide the connection credentials. For more information, see your specific provider's documentation to obtain or to generate them.
Web access URL: URL where your OneRoster API is accessible for your SIS/SMS
Client ID that is used to connect to your SIS/SMS OneRoster API
Client Secret that is used to connect to your SIS/SMS OneRoster API
Access Token URL, if your SIS/SMS OneRoster API is configured for authentication using OAuth2, you need to provide the Access Token URL endpoint that used to connect. The endpoint is different from the Web access URL.
SIS Vendor | Aequitas Solutions, Inc |
---|---|
Minimum Version of Software | Q 3.6.1, Q Web API 3.6.0 |
Configuration Prerequisites | See Q Web API set up |
How to get Client ID, Client Secret, and URL(s) | See Q Web API set up |
Specific Instructions | N/A |
Help | Contact Support at (909) 946-1600 |
SIS Vendor | Aeries |
---|---|
Minimum Version of Software | v8.18.6.29 or later |
Configuration Prerequisites | See OneRoster API Set Up. |
How to get Client ID, Client Secret, and URL(s) | Self-hosted. See OneRoster API Set Up. |
Specific Instructions | N/A |
Help | Contact Support at Phone (toll-free): (888) 324-5363 or support@aeries.com |
SIS Vendor | Arbor Education |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | The integration between Arbor MIS and SDS is enabled on your Arbor MIS. Contact your account manager at Arbor to make sure it's enabled via accountmanagers@arbor-education.com. You must have an Office 365 education tenant, global administrator permissions, and School Data Sync (Plan 1) enabled. |
How to get Client ID, Client Secret, and URL(s) | Generate in your Arbor MIS. Steps to complete are detailed in the Arbor Help Center. |
Specific Instructions | Contact Arbor or your dedicated support partner to help set up this integration via myteam@arbor-education.com. |
Help | Find support articles at Arbor's Help Centre. For questions, reach out to myteam@arbor-education.com or your dedicated support partner. |
SIS Vendor | Blackbaud Education Management |
---|---|
Minimum Version of Software | The latest version of BEM is always available to users. |
Configuration Prerequisites | Not applicable |
How to get Client ID, Client Secret, and URL(s) | The step-by-step instructions are described here |
Specific Instructions | When selecting your mapping settings for your Microsoft Entra users, be sure your settings to include/exclude the domain suffix matches your Microsoft Entra usernames. This action ensures the best results when matching BEM students and teachers to your Microsoft Entra users. |
Help | support.blackbaud.com |
SIS Vendor | Bubblecon |
---|---|
Specific Instructions | Reachout to Bubblecon Customer support team. |
SIS Vendor | ClassLink |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | Add the SDS app in the console. Select on Adding Applications & Modifying Permissions for instructions. |
How to get Client ID, Client Secret, and URL(s) | Customers can get their oAuth credentials from the console after they add the app. An email is to the developer at Microsoft that set up the app. Select on Adding Applications & Modifying Permissions to show the location to obtain the client ID and secret. |
If there are issues connecting, ensure that the Web Access URL has "/ims/oneroster/v1p1" to point to the correct connectors. | |
Specific Instructions | N/A |
Help | E-mail rostersupport@classlink.com. |
SIS Vendor | Classter |
---|---|
Minimum Version of Software | All versions are supported |
Configuration Prerequisites | https://help.classter.com/kb/integration-with-sds/sds-integration-manual/ |
How to get Client ID, Client Secret, and URL(s) | https://help.classter.com/kb/integration-with-sds/sds-integration-manual/ |
Specific Instructions | https://help.classter.com/kb/integration-with-sds/sds-integration-manual/ |
Help | support@classter.com |
SIS Vendor | Edge Learning |
---|---|
Minimum Version of Software | Edge is a web application, there's no minimum version required. |
Configuration Prerequisites | Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster |
How to get Client ID, Client Secret, and URL(s) | Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster |
Specific Instructions | Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster |
Help | Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster |
SIS Vendor | Educate by Community Brands |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | Contact customer support. |
Specific Instructions | Contact customer support. |
Help | For support, contact educate_support@communitybrands.com. |
SIS Vendor | Edulife Connect |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | Done directly in contact with our deployment and support team. |
Specific Instructions | N/A |
Help | Contact support at support@wizkids.co.uk. // 020 7550 9286 |
SIS Vendor | eSchoolData |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | Districts must be subscribers of the eSD GURU product. |
How to get Client ID, Client Secret, and URL(s) | See specific instructions. |
Specific Instructions | In order to enable an API integration with SDS, district administrators must first create a vendor account within GURU. Navigate to Configuration > Vendors and select Create New Vendor. Enter a Vendor Name and retain the Client ID and Client Secret that are automatically generated. Provide, along with your regional GURU API URL, when configuring the SDS integration. Select Next and enable all OneRoster API permissions. Select Finish when complete to save the new account. |
Help | For questions, contact your eSchoolData support team. |
SIS Vendor | eSchooling by Codevision |
---|---|
Minimum Version of Software | 1.1.20 |
Configuration Prerequisites | None |
How to get Client ID, Client Secret, and URL(s) | Follow directions in eSchooling platform: System Administration > School Data Sync |
Specific Instructions | Same as prior |
Help | Contact suporte@codevision.pt |
SIS Vendor | DataEum |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | None |
How to get Client ID, Client Secret, and URL(s) | Email customer support to request OneRoster API credentials. |
Specific Instructions | Contact customer support pbd@dataeum.kr |
Help | Contact customer support pbd@dataeum.kr |
SIS Vendor | Eventful |
---|---|
Minimum Version of Software | A list of supported student registers can be found at Eventful OneRoster. |
Configuration Prerequisites | Reach out to Eventful by email at info@eventful.se or by phone at (+46) 10 209 9001 |
How to get Client ID, Client Secret, and URL(s) | Provided in the setup process. |
Specific Instructions | N/A |
Help | Contact Eventful Support by email at info@eventful.se or by phone at (+46) 10 209 9001 |
SIS Vendor | FACTS |
---|---|
Minimum Version of Software | Not applicable. Latest version is always available to customers. |
Configuration Prerequisites | Not applicable |
How to get Client ID, Client Secret, and URL(s) | Customers sign up for OneRoster API and FACTS provides this information to them. |
Specific Instructions | From within the SIS, go to System > Configuration > SIS Integrations > OneRoster API > Fill out form. |
Help | Customer Support 866-800-6593 |
SIS Vendor | Focus School Software |
---|---|
Minimum Version of Software | Focus v 8.7 |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | From the Focus portal screen, Setup > System Setup > Third Party Systems. On the record insert row, enter, Title: Microsoft Version 1.0 > Dialect: OneRoster. Upon saving, the URL, Client ID and client secret are generated. |
Specific Instructions | N/A |
Help | Call Focus' phone support line at 877-410-6637. |
SIS Vendor | Follett Aspen |
---|---|
Minimum Version of Software | Latest version of Aspen, 5.9 |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | Contact the Customer Relationship Manager for your district to schedule the upgrade. |
Specific Instructions | N/A |
Help | Contact your Customer Relationship Manager for help. |
SIS Vendor | Furlong Schoolbase |
---|---|
Minimum Version of Software | Hosted schools only using the latest version |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | Instructions can be found here. |
Specific Instructions | N/A |
Help | Open a ticket with Furlong. |
SIS Vendor | INACAP SDS API |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | On-premises System for INACAP, contact sistemas@inacap.cl if necessary. |
Specific Instructions | N/A |
Help | Contact INACAP Support by email at sistemas@inacap.cl. |
SIS Vendor | Informat |
---|---|
Minimum Version of Software | N/A |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | Client ID and Client Secret will be provided after completing the intake form |
Specific Instructions | Detailed instructions are available on https://helpdesk.informat.be/hc/nl/articles/5365008451858-Koppeling-Office-365| |
Help | Contact Informat Helpdesk at https://helpdesk.informat.be/hc/nl |
SIS Vendor | Infinite Campus |
---|---|
Minimum Version of Software | For roster provisioning, the minimum version is Campus.1821. |
Configuration Prerequisites | Creating an OAuth Client |
How to get Client ID, Client Secret, and URL(s) | Sign in and find latest product documentation for the oAuth configuration screen can be found at OneRoster guidance for Infinite Campus |
Specific Instructions | Prior to V 1933.3 - Go to the Infinite Campus user interface >> select System Administration >> select Campus Learning >> select OneRoster Tools >> select on OneRoster. Version 1933.3 and later - Go to the Infinite Campus user interface >> select System Administration >> select Learning Interoperability |
When selecting attributes within Infinite Campus to sync, ensure that period is not selected. If it's selected, there's a possibility it generates a large number of errors when syncing and lock the profile in quarantine. | |
Help | For Help, contact your Customer Success Manager. |
SIS Vendor | inLogic |
---|---|
Minimum Version of Software | V7.7.510 |
Configuration Prerequisites | N/A |
How to get Client ID, Client Secret, and URL(s) | There's a wiki page for the customer InLogic and Teams integration. |
Specific Instructions | More instructions to help or get SDS setup with the SIS can be found at InLogic and Teams integration. |
Help | For e-mail support, go to support@inlogic.dk, for Phone support, +45 42 40 88 15, and web support, https://www.inlogic.dk/support/. |
SIS Vendor | iSAMS by IRIS |
---|---|
Minimum Version of Software | 21.4.23.12 |
Configuration Prerequisites | None |
How to get Client ID, Client Secret, and URL(s) | You should email helpdesk requesting OneRoster API credentials at helpdesk@isams.co.uk |
Specific Instructions | None |
Help | Contact iSAMS Helpdesk to ask for help document at helpdesk@isams.co.uk. |
SIS Vendor | IST |
---|---|
Minimum Version of Software | Not applicable. |
Configuration Prerequisites | See specific instructions. |
How to get Client ID, Client Secret, and URL(s) | See specific instructions. |
Specific Instructions | Information for setup is provided privately. |
Help | For questions, contact your IST support team. |
SIS Vendor | LIBRUS |
---|---|
Minimum Version of Software | Current version |
Configuration Prerequisites | Client must have a license for LIBRUS Synergia |
How to get Client ID, Client Secret, and URL(s) | To enable an API integration with SDS, you must be logged in as an administrator or school principal. Navigate to Settings > Configuration > Other options > Office 365 Integration |
Specific Instructions | Detailed instructions are available in the help section. |
Help | Contact our support team at pomoc@LIBRUS.pl |
SIS Vendor | MySchool Ltd |
---|---|
Minimum Version of Software | Not applicable |
Configuration Prerequisites | Initial setup of the MySchool system assisted through support team. |
How to get Client ID, Client Secret, and URL(s) | Assisted through support team. |
Specific Instructions | Support can be found here |
Help | Contact us |
SIS Vendor | TeacherPlus Gradebook by Rediker Software |
---|---|
Minimum Version of Software | 1.12.0.0 |
Configuration Prerequisites | None. OneRoster integration is enabled for all the schools by default. |
How to get Client ID, Client Secret, and URL(s) | Autogenerated by the program when a new school has been created. Admin can manage user settings through the Gradebook Manager application. |
Specific Instructions | None |
Help | Questions can be directed to GBSupport@rediker.com or APSupport@rediker.com |
SIS Vendor | SIMS by Education Software Solutions |
---|---|
Minimum Version of Software | SIMS 7 Summer 2019 or later |
Configuration Prerequisites | A SIMS ID account is required. |
How to get Client ID, Client Secret, and URL(s) | Use this support link for SDS |
Specific Instructions | See https://id.sims.co.uk/support/wiki/136 |
Help | See https://id.sims.co.uk/support/ |
SIS Vendor | Skool |
---|---|
Minimum Version of Software | Miloo+ service is required to enable School Data Sync |
Configuration Prerequisites | Contact your Account Manager with Skool to set up and enable SDS. |
How to get Client ID, Client Secret, and URL(s) | N/A |
Specific Instructions | N/A |
Help | Contact Skool support at (+31) 40 750 77 77 or by email at servicedesk@skool.nl. |
SIS Vendor | Skyward |
---|---|
Minimum Version of Software | 05.20.10.00.10 |
Configuration Prerequisites | The Skyward API must be installed. The API is a separate IIS web application from the main Skyward application. |
How to get Client ID, Client Secret, and URL(s) | This document shows how to set up the API and generate a key and secret |
Specific Instructions | Specific instructions can be found in this document |
Help | Submit a service call within https://support.skyward.com |
SIS Vendor | SmartSchool |
---|---|
Minimum Version of Software | Product is a SaaS solution, all clients have the latest version |
Configuration Prerequisites | No specific prerequisites |
How to get Client ID, Client Secret, and URL(s) | In the software, go to ‘General Configuration’, ‘OneRoster clients’, and follow the instructions there. |
Specific Instructions | N/A |
Help | Customers can contact SmartSchool by known support channels. |
SIS Vendor | Synergy SIS by Edupoint |
---|---|
Minimum Version of Software | 2022 |
Configuration Prerequisites | OneRoster API License Key |
How to get Client ID, Client Secret, and URL(s) | Contact Edupoint support |
Specific Instructions | N/A |
Help | https://support.edupoint.com/ |
SIS Vendor | Trivium |
---|---|
Minimum Version of Software | 1.0 |
Configuration Prerequisites | Contact Trivium - Microsoft Partner for configuration. |
How to get Client ID, Client Secret, and URL(s) | Contact Trivium - Microsoft Partner to generate Client ID and Secret. |
Specific Instructions | None |
Help | https://www.trivium.com.br/contato/ and suporte@trivium.com.br |
SIS Vendor | Vigilo |
---|---|
Minimum Version of Software | None |
Configuration Prerequisites | None |
How to get Client ID, Client Secret, and URL(s) | Contact Vigilo. |
Specific Instructions | None |
Help | Contact Vigilo for support through the process. |
SIS Vendor | Visma Enterprise AS |
---|---|
Minimum Version of Software | None |
Configuration Prerequisites | None |
How to get Client ID, Client Secret, and URL(s) | Contact Visma Support |
Specific Instructions | Contact Visma Support |
Help | Contact Visma Support at https://inschool.zendesk.com. |
SIS Vendor | VULCAN UONET+ |
---|---|
Minimum Version of Software | Current |
Configuration Prerequisites | Client must have a license for UONET+ |
How to get Client ID, Client Secret, and URL(s) | From the VULCAN Admin portal; Select “Configuration” > “Office 365 settings” > API exchange configuration. Enable “Synchronization with Office 365”. On this tab, you receive the Client ID, Client Secret, and URL(s). |
Specific Instructions | N/A |
Help | Contact Support at https://vulcan.edu.pl during standard office hours. |
Training
Learning path
School Data Sync advanced for education partners - Training
Education partners learn how to implement School Data Sync for education customers. Part of the Partner Success Series.