Overview ↑
Aeries SIS has developed an API based on the OneRoster® 1.1 specification. OneRoster is a standard for securely exchanging data between student information systems (SIS) and other applications such as Learning Management Systems (LMS). More information is available on the IMS Global website:
http://www.imsglobal.org/activity/onerosterlis
The OneRoster CSV extracts have been updated to support Flex Scheduling schools.
User - Teacher ↑
The User - Teacher extract file pulls information from the Staff (STF) table instead of TCH for a Flex and Section Staff schools. The identifier element will extract the school linked to the Staff according to the SSE table.
NOTE: All staff sourcedIds for OneRoster endpoints and OneRoster CSV files are prefaced with TCH_ or _TCH_
Enrollment - Teacher ↑
In a Flex School, a teacher record is identified and linked to a master schedule from the Section Staff table (SSE).
This table can store multiple teachers for each section. The extract will pull any and all active teachers (primary and non-primary) and will honor the Start and End Dates according to SSE.SD and SSE.ED fields.
The Enrollment - Teacher file data mapping example is shown below. In a Flex School, the sourcedId element will pull SC field from the MST table, the Staff ID from STF table according to the Staff ID linked in the SSE table and the section number.
Class/Classes - Secondary ↑
The Class/Classes - Secondary extract file will pull the period information according to the (FTF) Flex Periods and includes the start and end times of the period.
NOTE: OneRoster extracts and OneRoster API calls require a current class enrollment record (ATT/ENR). Students not having current enrollment at the time the extract is created will not be included in the extract results.
API Configurations ↑
For information on API Setup and Security, see OneRoster API Setup documentation.
For information on API Available endpoints, see OneRoster API Available endpoints documentation.
For information on the API Authentication Process, see OneRoster API Authentication Process documentation.
For a complete listing of OneRoster Data Mappings, see Aeries to OneRoster Data Mapping.