OneRoster File Specifications: enrollments.csv

This article explains the enrollments.csv file specification for OneRoster v1.1 customers.

If this is your first time using bulk-formatted OneRoster v1.1 CSV files, we recommend using the 1EdTech CSV ZIP File Validation tool to check your files for formatting and data errors prior to sending them via SFTP to Great Minds.

In order to use this tool, you must log into an active 1EdTech account. If you do not have a 1EdTech account, you can sign up for a free account.

File Requirements

In order for your file to process successfully, your file must meet the following criteria:

• Must be in .csv format named “enrollments.csv” within your OneRoster zip file
• Must contain all column headers listed in the order shown below (even if you intend to leave the column blank)
• Must not be empty
• Contains data in all required columns

See 1EdTech's website for the full specification for the enrollments.csv file. The specification has been modified below to include Great Minds support.
 

Column Field Header	Required	Supported Format	1EdTech Description	Great Minds Data Requirements	Example Data
sourcedId	Yes	GUID	Unique identifier of this enrollment.		9877728989-BCHEM-0001-442
status	No	Enumeration	The status of the record.  Note: Leave this column blank. Great Minds supports bulk mode only and does not read data in this column.
dateLastModified	No	dateTime	The date that this record was last modified. Note: Leave this column blank. Great Minds supports bulk mode only and does not read data in this column.
classSourcedId	Yes	GUID Reference	SourcedId of the Class.		9877728989-BCHEM-0001
schoolSourcedId	Yes	GUID Reference	SourcedId of an Org with type 'school.'	Must be “school” org type	1888
userSourcedId	Yes	GUID Reference	SourcedId of the User.		jonathonrogers
role	Yes	Enumeration	Permitted values: administrator, proctor, teacher, student	Must be “teacher” or “student”	teacher
primary	No	Enumeration	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.	Exactly one user with a role of “teacher” must be primary=true for each class Only users with a role of “teacher” can have primary=true	true
beginDate	No	Date	The start date for the enrollment. This date must align with the associated academic session (term) identified in the class.		2022-09-01
endDate	No	Date	The end date for the enrollment (exclusive). This date must align with the associated academic session (term) identified for the class.		2023-06-30

Tips

Great Minds does not support class enrollments for the following roles:

• proctor
• administrator

The following fields are not currently utilized in Great Minds products:

• beginDate
• endDate

Format Definitions

 

Format Type	Definition
GUID	'GUID' denotes some form of globally unique identifier (this must be less than 256 characters). This is not restricted to the 128 bit UUID format.
GUID Reference	'GUID Reference' denotes the GUID of an object defined in some other CSV data file.
Date	"Date" denotes a date format. Dates MUST be expressed using ISO 8601 format, more commonly formatted as "YYYY-MM-DD" e.g., "2002-04-23"
Enumeration	'Enumeration' denotes a fixed set of values that will be referred to in the description. In the case of fields which are not required, an empty field denotes no value.