OneRoster Developer FAQs

When using the REST API can I send a null value or empty field to indicate a lack of data in a OneRoster JSON payload?
No, NULL and EMPTY fields MUST NOT occur within a JSON payload (note this is NOT dependent on the multiplicity of the field). In many cases, a NULL/EMPTY v...
Wed, 13 Jan, 2021 at 3:17 PM
Considerations for assignment of sourcedIDs
SourcedID is used to provide the unique identification of any object between two OneRoster endsystems. Ideally, each sourcedID should be a globally unique ...
Wed, 13 Jan, 2021 at 3:17 PM
Many service implementations need proprietary features. What mechanisms should be used to make the details about these features for an actual OneRoster service provision available?
The specification has several mechanisms to enable such provisioning e.g. the set of OAuth 2 scopes can be extended. The best way to distribute information...
Wed, 13 Jan, 2021 at 3:18 PM
What error reporting does OneRoster include?
OneRoster 1.1 requires that all requests MUST support error reporting. The set of error code responses defined in OneRoster 1.1 can be found here. Addi...
Wed, 13 Jan, 2021 at 3:20 PM
How do you identify which students are actively enrolled in a class?
OneRoster provides the ability to denote the status of a database record as well as the ability to denote the status of the object it references. Of partic...
Wed, 13 Jan, 2021 at 3:21 PM
Can OneRoster be used to identify all of the parents or guardians of students in a specific school?
Yes. For this to be done however, it is critical that when the parent is added to the database that their record is flagged correctly. The users who have r...
Wed, 13 Jan, 2021 at 3:22 PM
How do I link to educational resources in my OneRoster Integration?
OneRoster facillitates access to the resources needed for teaching and learning. To this end, in the object definition for a resource the property vendorRe...
Wed, 13 Jan, 2021 at 3:23 PM
How do you identify that a score that was submitted late?
In OneRoster 1.1 the enumerated vocabulary for scoreStatus does not contain a value to specifically denote that a score is late. In OneRoster 1.2 the p...
Wed, 13 Jan, 2021 at 3:23 PM