OneRoster (Google Classroom) Export

Modified on Mon, Feb 26 at 10:07 AM

OneRoster (Google classroom) Export

Overview

This export will export comma separated files (.csv). The included files are orgs.csv, users.csv, courses.csv, classes.csv, enrollments.csv, academicSessions.csv, demographics.csv

Official Specifications: https://www.imsglobal.org/lis/imsOneRosterv1p0/imsOneRosterCSV-v1p0.html

Options

The files can be saved to a path on the local machine, sent to an email address, or sent out via FTP (active, passive, or secure FTP).
Can set username to be first initial last name, or email. Will default to the id but an error will be sent informing you of this
Can be sent as a single zip that you name, or as separate files in .csv format
Schools can be selected by checking the box next to their names.

Output ( taken from https://www.imsglobal.org/lis/imsOneRosterv1p0/imsOneRosterCSV-v1p0.html)

orgs.csv

field header	required	format	description
sourcedId	Yes	string	unique id for the organization. SourcedId is used in other files and must be unique across all organizations. (For example –schools in your district).
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (format is YYYY-MM-DD)
name	Yes	string	name of the organization
type	Yes	String	“school” \| “local” \| “state” \| “national”
identifier	No	string	NCES ID National Center for Education Statistics) for the school / district

users.csv

field header	required	format	description
sourcedId	Yes	String	Unique ID for the user. SourcedId is used in other files and must be unique across all users,
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
orgSourcedIds	Yes	String	SourcedIds of the Organizations to which this user belongs. If multiple Ids are required then use double quotes and separate with commas. (Note in most in cases, it is expected that users will belong to a single school).
role	Yes	String	“teacher”, “student”, “parent”, “guardian”, “relative”, “aide”, “administrator”
username	Yes	String	Username
userId	No	String	external machine readable id (e.g. LDAP id, LTI id) for this user, to be used if the sourcedId should not be used.
givenName	Yes	String	User’s first name
familyName	Yes	String	User’s surname
identifier	No	String	Identifier for the user with a human readable meaning
email	No	String	Email address for the user
sms	No	String	SMS address for the user
phone	No	String	Phone number for the user

courses.csv

field header	required	format	description
sourcedId	Yes	String	Unique ID for the course. SourcedId is used in other files and must be unique across all courses.
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
schoolYearId	No	String	School year in which course runs. This the sourcedId of an academic Session (see below)
metadata.duration	No	String	Description of how long the course runs for (e.g. two weeks, one semester).
title	Yes	String	Name of the course
courseCode	No	String	Human readable course code
grade	No	String	Grade (i.e. 9 or range 9-12)
orgSourcedId	No	String	SourcedId of the org to which this course belongs. This may be a district level org Id.
subjects	No	String	Subject name(s). If more than one subject is needed, use double quotes, and separate with commas (per RFC 4180): Examples: “chemistry, physics” physics “music, drama, poetry”

classes.csv

field header	required	format	description
sourcedId	Yes	String	Unique ID for the class. SourcedId is used in other files and must be unique across all classes.
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
title	Yes	String	Name of this class
grade	No	String	Grade (i.e. 9 or range 9-12) the grades field will populate with either: -a comma separated created list of the NCES Grade span from the curriculum course e.g. ("09","10") or, if that is blank - the grades levels for the school in which the course is offered.
courseSourcedId	No	String	SourcedId of the course of which this class is an instance
classCode	No	String	Human readable code used to help identify this class
classType	Yes	String	“homeroom”, “scheduled”
location	No	String	Human readable description of where the class is physically located
schoolSourcedId	Yes	String	SourcedId of the organization which teaches this class
termSourcedId	Yes	String	SourcedId of the academicSessions(s) in which the class is taught. If more than one term is needed, use double quotes and delimit with commas, (per RFC 4180) Examples: “1,2” 1 “1,4,8”
subjects	No	String	Subject name(s). If more than one subject is needed, use double quotes, and delimit with commas (per RFC 4180): Examples: “chemistry, physics” physics “music, drama, poetry”

enrollments.csv

field header	required	format	description
sourcedId	Yes	String	Id of this enrollment
classSourcedId	Yes	String	Id of the class
schoolSourcedId	Yes	String	Id of the school
userSourcedId	Yes	String	Id of the user (teacher or student)
role	Yes	String	“student” \| “teacher” \| “parent” \| “guardian” \| “relative” \| “aide”, “administrator”
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
primary	No	Boolean	MUST only be set to true for ONE teacher for a class.

academicSessions.csv

field header	required	format	description
sourcedId	Yes	String	SourcedId of this academicSession. AcademicSessions are used in other files and need to be unique across all academicSessions.
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
title	Yes	String	Name or title of the grading period
type	Yes	String	“term”, “gradingPeriod”, “schoolYear”, “semester”
startDate	Yes	String	Start date
endDate	Yes	String	End date
parentSourcedId	No	String	Sourced id of parent of this academic session

demographics.csv

field header	required	format	description
userSourcedId	Yes	String	SourcedId of the user to which the demographcis refer. Typically this will be a student.
status	No	String	“active” \| “inactive” \| “tobedeleted”. A tobedeleted object may be deleted in receiving systems if it already exists
dateLastModified	No	Date	The date that this record was last modified. (FORMAT IS YYYY-MM-DD)
birthdate	Yes	Date	Student’s date of birth
sex	Yes	String	“Female” \| “Male”
americanIndianOrAlaskaNative	Yes	Boolean
asian	Yes	Boolean
blackOrAfricanAmerican	Yes	Boolean
nativeHawaiianOrOtherPacificIslander	Yes	Boolean
white	Yes	Boolean
demographicRaceTwoOrMoreRaces	Yes	Boolean
hispanicOrLatinoEthnicity	Yes	Boolean
countryOfBirthCode	Yes	String	Vocabulary – https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20002
stateOfBirthAbbreviation	No*	String	Vocabulary – https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20837 NOTE: For US and US territories, this field should be considered mandatory. For outside of the US, this field is optional.
cityOfBirth	Yes	String
publicSchoolResidenceStatus	Yes	String	Vocabulary - https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20863