Documentation

What is OneRoster API?

Suggest Edits

OneRoster® is an Industry Standard format for the exchange of Student Information System (SIS) data. The OneRoster® REST APIs are the means by which we can sync objects from SISs that provide OneRoster® APIs to School Passport.

School Passport supports integration with Student Information Systems (SIS) via OneRoster v1.1 REST API to roster schools, users, classes, and enrollments. This integration allows districts to efficiently manage the rostering of schools, users, classes, and enrollments

Supported data

OneRoster API supports a comprehensive range of educational data elements essential for efficient management and interoperability within learning ecosystems. The key data entities are as follows:

  • Users: This includes students, teachers, administrators, and other personnel involved in the learning process. User data includes identifiers, roles, contact information, and authentication details.

  • Courses: Information about courses offered, including course codes, titles, descriptions, and associated metadata.

  • Classes: Details regarding specific instances of courses conducted within a defined timeframe, such as class rosters, schedules, and enrollment information.

  • Enrollments: The API supports different data loads, allowing educational institutions to expand their systems without compromising performance or scalability.

📘

Note

Extend your OneRoster API using the Events API. This enables to track not just data but also the associated events that occurred with it. Learn more about Events API

Benefits of OneRoster API

Implementing OneRoster API offers several advantages:

  • Interoperability: The OneRoster API enables seamless integration between educational software applications, reducing manual data entry and improving data flow.

  • Standardization: The OneRoster API ensures consistency and compatibility among disparate systems by adhering to a unified data model and protocol.

  • Efficiency: Automating data synchronization improves efficiency by streamlining class management, student enrollment, and course provisioning processes.

  • Scalability: The API is designed to handle varying data loads, allowing educational institutions to scale their systems without compromising performance.

Updated 11 months ago