Reference

OneRoster Format

OneRoster v1.2 data specification

OneRoster Format

SDM uses OneRoster v1.2 as its internal data format.

Entities

Organizations (orgs)

Field	Type	Required
sourcedId	string	Yes
status	enum	Yes
name	string	Yes
type	enum	Yes
parentSourcedId	string	No

Users

Field	Type	Required
sourcedId	string	Yes
status	enum	Yes
enabledUser	boolean	Yes
role	enum	Yes
givenName	string	Yes
familyName	string	Yes
email	string	No

Courses

Field	Type	Required
sourcedId	string	Yes
status	enum	Yes
title	string	Yes
courseCode	string	No
orgSourcedId	string	Yes

Classes

Field	Type	Required
sourcedId	string	Yes
status	enum	Yes
title	string	Yes
courseSourcedId	string	Yes
schoolSourcedId	string	Yes

Enrollments

Field	Type	Required
sourcedId	string	Yes
status	enum	Yes
classSourcedId	string	Yes
userSourcedId	string	Yes
role	enum	Yes

Status Values

active - Currently valid
tobedeleted - Marked for deletion
inactive - Not currently active

Roles

student
teacher
administrator
aide

Reference

Technical reference documentation

ASM Format

Apple School Manager CSV format

On this page

OneRoster Format Entities Organizations (orgs)Users Courses Classes Enrollments Status Values Roles