OneRoster Developer FAQs

Best Practices for CSV files in OneRoster
Below are some Best Practices while implementing CSV files in OneRoster FilesField Issue Rationale users.csvgradesThe student grade level should be included...
Wed, 24 Jul, 2019 at 9:11 AM
OneRoster REST School Year Format
To appropriately use School Year in the REST Implementation of OneRoster, use the following format: “schoolYear”: “2017” The year must be in quotes.
Fri, 9 Aug, 2019 at 3:16 PM
Teachers in Multiple Schools
If you have teachers that are working in multiple schools, you should create a separate record for each teacher.  Only one sourcedId is permitted in such fi...
Wed, 4 Sep, 2019 at 12:36 PM
active and tobedeleted Fields in OneRoster v1.1
The ’status’ field MUST only be used to indicate if the record is ‘active’ or ’tobedeleted’.  This value bears NO relationship to the values in the associat...
Wed, 11 Sep, 2019 at 12:12 PM
When using the REST API, can a Consumer request data, from a Service Provider, that is filtered according the ‘dateLastModified’ field?
Yes.  All Service Providers MUST support requests from a Consumer that include the use of ‘filter’ Query Parameter and MUST provide only the data that compl...
Tue, 1 Dec, 2020 at 2:17 PM
What is the required accuracy when providing values for properties that have a data-type of Date/Time?
In both CSV and REST API bindings, a property that has a data-type of Date/Time MUST comply with the ISO 8061 format.  Such properties include ‘dateLastModi...
Tue, 1 Dec, 2020 at 2:19 PM
What are the permitted values for properties that have a data-type of Boolean?
In both CSV and REST API bindings, a property that has a data-type of Boolean MUST have a value of “true” or “false”.  Therefore, values of “0”, “1”, “True”...
Tue, 1 Dec, 2020 at 2:21 PM
Can the enumerated vocabularies be extended?
For OneRoster 1.1, in both CSV and REST API bindings the enumerated vocabularies MUST NOT be extended.  If the vocabularies are extended, the CSV file or JS...
Tue, 1 Dec, 2020 at 2:22 PM
What is the best way to handle the mapping between old/new SourcedIds or to migrate from one set of SourcedIds to another?
The established best practice is to use a CSV file in which the mapping between the old and new SourcedIds is provided i.e.  one column of old SourcedIds an...
Mon, 4 Jan, 2021 at 9:33 AM
Are SCED codes the only permitted vocabulary for ‘subject codes’?
The use School Courses for the Exchange of Data (SCED) codes SHOULD be used for systems deployed in the USA.  Note that there are several versions of SCED c...
Tue, 1 Dec, 2020 at 2:24 PM