OneRoster File Specifications: classes.csv
This article explains the classes.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.
This may take up to 24 hours. If you need additional assistance with your 1EdTech account or the CSV Zip File Validation tool, contact 1EdTech directly.
File Requirements
- Must be in .csv format named “classes.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
Column Field Header | Required | Supported Format | 1EdTech Description | Great Minds Data Requirements | Example Data |
---|---|---|---|---|---|
sourcedId | Yes | GUID | Unique ID for the class. SourcedId is used in other files and must be unique across all classes. |
|
9877728989-BCHEM-0001 |
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. |
||
title | Yes | String | Name of the class. |
|
Basic Chemistry |
grades | No | String | Grade(s) for which the class is attended. The permitted vocabulary is from CEDS (Version 5) and the 'Entry Grade Level' element. | Must be exactly one of the following values: IT, PR, PK, TK, KG, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, PS, UG, Other | 09 |
courseSourcedId | Yes | GUID Reference | SourcedId of the course of which this class is an instance. | CHEM-0001 | |
classCode | No | String | Human readable code used to identify the class. | Chem101-Mr Rogers | |
classType | Yes | Enumeration | Permitted values: homeroom, scheduled. | scheduled | |
location | No | String | Human readable code used to identify the class. | room 19 | |
schoolSourcedId | Yes | GUID Reference | SourcedId of the Org the class belongs to. The OrgType must equal "school." | Must belong to an existing org with type “school” | 1888 |
termSourcedIds | Yes | List of GUID References | SourcedId of the terms (the academicSessions) in which the class is taught. | 2022-2023-YEAR | |
subjects | No | String |
Subject name(s) in human readable form. If the 'subjectCodes' attribute is present, the subjects and subjectCodes lists must have the same length and have order significance The vocabulary is from SCED (School Codes for the Exchange of Data) (Version 4) for the "Course Title" field. If the value of the "Course Title" contains commas, those commas must be removed. For example, the "Course Title" for "SCED Course Code" "03210" is "Science, Technology and Society." This must be represented as "Science Technology and Society." |
Must contain one of the following values:
|
science |
subjectCodes | No | String |
Subject codes(s) in machine readable form. If more than one subject code is needed, use double quotes and separate with commas (per RFC 4180). If the 'subjects' attribute is present, the two lists must have the same length and have order significance. For deployments in the USA, this vocabulary should be a School Courses for the Exchange of Data (SCED) code. |
03101 | |
periods | No | String |
The time slots in the day that the class will meet. If more than one period is needed, use double quotes, and separate with commas (per RFC 4180). Examples: 1; "1,3,5" |
5 |
Tips
- Great Minds does not support classes with multiple grade levels or subject areas. If more than one grade level or subject area is provided, only one will be chosen.
- Great Minds does not currently support the SCED vocabulary. Unsupported subject values will be processed as “Other.”
- The following fields are not currently utilized in Great Minds products:
- courseSourcedId
- classCode
- classType
- location
- termSourcedIds
- subjectCodes
- periods
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. |
List of GUID Reference | 'List of GUID Reference' denotes a comma-delimited list of GUID References of objects defined in another CSV data file. |
String | 'String' denotes a sequence of characters that should follow the description. Generally this is aimed to be human-readable, e.g., "Science Lesson.” |
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. |