Use the OneRoster Enrolments template in Apple School Manager
Use the OneRoster Enrolments template to import a class roster. Within an organisation, every sourcedID value must be unique — for every row in every sourcedID template for every location. For example, if an OneRoster Enrolments template has 600 students, that is 600 rows of unique sourcedID values, each student’s sourcedID value, and the student’s associated class sourcedID value.
It must also contain the class sourcedID value of each course and contain at least one student sourcedID value. Additional students are added by row. For example, 10 students would mean 10 rows — one for each student.
Value | Description | Example | Required/Unique | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
sourcedID | The number used to uniquely identify this enrolment in your SIS or other database. | BE8FF4CC-5BE2-47C6-9C42-6CDADB9072F8 | Yes/Yes | ||||||||
classSourcedID | The sourcedID of a class. | F9BF05A9-E40B-4CAD-9B4A-2E0C09EDCCC4 | Yes/No | ||||||||
userSourcedID | The sourcedID of the student who takes the class or the instructor who leads the class. | AE4A6BB3-8D97-446A-BAA9-EDEA567453D3 | Yes/No | ||||||||
role | This person’s role. There are two options: “student” and “teacher”. | student | Yes/No | ||||||||
schoolSourcedID | The sourcedID of the school or department this class belongs to. | DF48675-8307-446A-BAA9-EDEA567493D3 | No/No | ||||||||
primary | Applicable only to users with the role of “teacher”. There are two options: “true” and “false”. Only one user should be designated as the primary teacher for a class in the period defined by the begin and end dates. | TRUE | No/No | ||||||||
beginDate | The start date for the enrolment. This date must align with the associated academic session (term) identified for the class. | 2026-08-22 | No/No | ||||||||
endDate | The end date for the enrolment (exclusive). This date must align with the associated academic session (term) identified for the class. | 2027-05-30 | No/No | ||||||||
status | The status of the enrollment record. There are two options: “active” or “tobedeleted”. | active | No/No | ||||||||
dateLastModified | The date that this enrollment information was last modified. Dates must be expressed using ISO 8601 format (more commonly formatted as YYYY-MM-DD). | 2024-06-26 | No/No | ||||||||