Share via

OneRoster API Data Accessed by School Data Sync

  • Article

Important

By connecting and making institution data available with School Data Sync, you acknowledge that you are authorized to share this data with Microsoft and commit to adhere to your organization’s data governance standards.

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.

The following list is provided to help you better understand what data is being accessed when connecting to your SIS/SMS via OneRoster API.

Required OneRoster API Endpoints for School Data

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 School Data Sync

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}’