OneRoster File Specifications: orgs.csv
This article explains the orgs.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
In order for your file to process successfully, your file must meet the following criteria:
- Must be in .csv format named “orgs.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 orgs.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 id for the organization. SourcedId is used in other files and must be unique across all organizations. |
|
1888 |
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. |
||
name | Yes | String | Name of the organization. | Brookside High School | |
type | Yes | Enumeration |
Permitted values: department, school, district, local, state, national The explicit hierarchy is: national -> state -> local -> district -> school. |
Must be “school” or “district” | school |
identifier | No | String | NCES ID (National Center for Education Statistics) for the school/district. | 370000082 | |
parentSourcedId | No | GUID Reference | SourcedId of an Org representing the Parent organization. | 1001 |
Tips
- Great Minds does not support the following org types:
- national
- state
- local
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. |
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. |