Having trouble with OneRoster? Please use this OneRoster template to identify issues in OneRoster files. It has each header needed, what each field should correspond to, if the info is required, and an example.
Header Names | Required Field? | Notes | Example |
sourcedId | yes | Unique identifier of this enrollment. | 777712382541047 |
status | no | Status will default to Active is no status is supplied. Permitted Values: "active" , "tobedeleted", or "inactive" . This MUST NOT be used for the Bulk mode. | active |
dateLastModified | no | This MUST NOT be used for the Bulk mode. (Format is: MM/DD/YYYY or YYY/MM/DD). |
|
classSourcedId | yes | SourcedId of the Class. | 123825 |
schoolSourcedId | yes | SourcedId of an Org with type 'school'. | 11 |
userSourcedId | yes | SourcedId of the User. | 41047 |
role | yes | The role of the user in the enrollment. The ONLY permitted values are: { administrator | proctor | student | teacher }. | teacher |
primary | no | Permitted values: { "true" | "false" }. Applicable only to teachers. Only one teacher should be designated as the primary teacher for a class in the period defined by the begin/end dates. | TRUE |
beginDate | yes | The start date for the enrollment (inclusive). This date must be within the period of the associated Academic Session for the class (Term/Semester/SchoolYear). (Format is: MM/DD/YYYY or YYY/MM/DD). | 7/1/21 |
endDate | yes | The end date for the enrollment (exclusive). This date must be within the period of the associated Academic Session for the class (Term/Semester/SchoolYear). (Format is: MM/DD/YYYY or YYY/MM/DD). | 6/30/22 |
---
Kathryn Carter - Community Moderator