OneRoster

Extract data from CSV files - Extracts data from OneRoster-formatted CSV files

File to extract CSV data from - A ZIP archive containing CSV files in OneRoster format. Input must be step data that references a file path from a previous step. See Using step data in Claris Connect Help.

Validate OneRoster ZIP file - Validates a ZIP archive of OneRoster-formatted CSV files

File to validate - A ZIP archive containing CSV files in OneRoster format. Input must be step data that references a file path from a previous step. See Using step data in Claris Connect Help.

Get data for Apple School Manager - Extracts data in bulk from your SIS for use by Apple School Manager

Classes status - Filter classes by their status in the data import. Based on OneRoster's classes data model.

Select either "active," "tobedeleted," or a custom status type

Courses status - Filter courses by their status in the data import. Based on OneRoster's courses data model.

Select either "active," "tobedeleted," or a custom status type

Enrollment status - Filter enrollments by their status in the data import. Based on OneRoster's enrollments data model.

Select either "active," "tobedeleted," or a custom status type

Org status - Filter orgs by their status in the data import. Based on OneRoster's orgs data model.

Select either "active," "tobedeleted," or a custom status type

Staff status - Filter staff by their status in the data import. Based on OneRoster's user data model for non-students.

Select either "active," "tobedeleted," or a custom status type

Student status - Filter students by their status in the data import. Based on OneRoster's users data model for students.

Select either "active," "tobedeleted," or a custom status type

Import Other Staff - Include administrator staff during the API import.

Active terms only - Include only class and enrollment records associated with the currently active term.

Active students only - Include only student records where the value of enabledUser is True, which generally indicates that the student is currently active. Based on the OneRoster user data model for students.

Active teachers only - Include only teacher records where the value of enabledUser is True, which generally indicates that the teacher is currently active. Based on the OneRoster user data model for teachers.

School - Include these schools in the data import. All schools are included by default.

Multi-Choice

Get classes - Return a list of classes

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get courses - Return a list of courses

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get enrollments - Return a list of enrollments

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get locations - Return a list of locations

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get schools - Return a list of schools

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get students - Return a list of students

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get teachers - Return a list of teachers

Sort by - Data field to sort the returned records by

Modified after - Documentation on filtering OneRoster records

YYYY-MM-DD

User Status - Documentation on filtering OneRoster records

Record offset - Index of the first record to return. Default value: 0

0

Record limit - Limits the number of returned records. Default value: 100

100

Order by - Orders the field in ascending or descending order. Default value: Ascending

Get a class - Return a specific class

Class ID - The ID of the class you want to return

Get a course - Return a specific course

Course ID - The ID of the course you want to return

Get an enrollment - Return a specific enrollment

Enrollment ID - The ID of the enrollment you want to return

Get a school - Return a specific school

School ID - The ID of the school you want to return

Get a student - Return a specific student

Student ID - The ID of the student you want to return