Which oneroster-v11-final-specification fields are required?

Forum:

OneRoster Public Forum

Which oneroster-v11-final-specification fields are required?

Submitted by jimpanzee on Tue, 09-Apr-2024 05:34.

Which oneroster-v11-final-specification fields are required?
https://www.imsglobal.org/oneroster-v11-final-specification

Or is the implication given that it's not mentioned anywhere I can see in the specification documentation that it is all of them?

For example if I look at the data model
https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452019
And the JSON data structure for the same
https://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452044

Which fields are absolutely required in that JSON data structure?

Hi Jim,

You can see which fields are required by looking at the multiplicity indicators next to each property name. For example for userName you see:

The multiplcity of 1 indicates that username is a required field. A multiplicity of 0 means the field is optional. "0..1" means that it is optional but at most can have 1.

You will also see examples like userIDs where the top level container is not required but if it is included nested items inside it are required:

Submitted by JoshuaMcGhee on Tue, 2024-04-09 09:05

The names 1EdTech^® and IMS Global Learning Consortium^®, the 1EdTech logos, Better Learning From Better Learning Technology^®, TrustEd Apps™, 1EdTech TrustEd Apps™, Learning Tools Interoperability^®, LTI^®, IMS LTI^®, IMS Learning Tools Interoperability^®, OneRoster^®, Caliper Analytics^®, Question & Test Interoperability (QTI)^®, QTI^®, Common Cartridge^®, Competencies and Academic Standards Exchange^®, CASE^®, Competencies and Academic Standards Exchange (CASE)^®, Accessible Portable Item Protocol (APIP)^®, AccessForAll^®, Badge Connect^®, Comprehensive Learner Record Standard™, and CLR Standard™ are trademarks of 1EdTech Consortium, Inc. in the United States and/or other countries. All other trademarks and registered trademarks are the properties of their respective owners.

For information on the 1EdTech trademark usage policy, see our trademark policy page.