What data do I need for my SFT SIS sync and how do I format it?

We only request rostering data from the SIS. This does not include demographic information, grades, or attendance information. We adhere to the OneRoster specifications for data obtained whether this sourced from a CSV upload or from an API call. What follows is the data that we require for a SIS integration.

academicSessions.csv

This file represents the AcademicSessions dataset from the OneRoster specification.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	SourcedId of this academicSession.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
title	Yes	String	Name or title of the academic session.
type	Yes	Enumeration	See section 4.13.7 [OneRoster, 20a] for the enumeration list.
startDate	Yes	Date	Inclusive start date for the academic session.
endDate	Yes	Date	Exclusive end date for the academic session.
parentSourcedId	No	GUID Reference.	SourcedId of the parent of this academic session.
schoolYear	Yes	Year	The school year for which the academic session contributes. This year should be that in which the school year ends.(Format is: YYYY).

classes.csv

This file represents the Class dataset from OneRoster specification.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	Unique ID for the class. SourcedId is used in other files and must be unique across all classes.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
title	Yes	String	Name of this class.
grades	No	List of Strings	Grade(s) for which the class is attended. The permitted vocabulary is from CEDS (Version 5) and the 'Entry Grade Level' element https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100
courseSourcedId	Yes	GUID Reference.	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	Enumeration	See section 4.13.1 [OneRoster, 20a] for the enumeration list.
location	No	String	Human readable description of where the class is physically located.
schoolSourcedId	Yes	GUID Reference.	SourcedId of the Org that teaches this class of OrgType "school".
termSourcedIds	Yes	List of GUID References.	SourcedId of the terms (the academicSessions) in which the class is taught.
subjects	No	List of Strings	Subject name(s) in human readable form. If the 'subjectCodes' attribute is present then the subjects and subjectCodes lists must have the same length and have order significanceThe vocabulary is from SCED (School Codes for the Exchange of Data) (Version 4) for the "Course Title" field: http://nces.ed.gov/forum/SCED.aspIf the value of the "Course Title" contains commas, then those commas must be removed.For example, the "Course Title" for "SCED Course Code" "03210" is "Science, Technology and Society". This must be represented as "Science Technology and Society".
subjectCodes	No	List of Strings	Subject codes(s) in machine readable form. If more than one subject code is needed, use double quotes, and separate with commas (per RFC 4180). If the 'subjects' attribute is present the two lists must have the same length and have order significance.For deployments in the USA this vocabulary SHOULD be a School Courses for the Exchange of Data (SCED) code: http://nces.ed.gov/forum/SCED.asp[.](http://nces.ed.gov/forum/SCED.asp)
periods	No	List of Strings	The time slots in the day that the class will be given. If more than one period is needed, use double quotes, and separate with commas (per RFC 4180).Examples: 1; "1,3,5"

courses.csv

This file represents the Course dataset from OneRoster.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	Unique ID for the course.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
schoolYearSourcedId	No	GUID Reference.	SourcedId of an AcademicSession with type of "schoolYear".
title	Yes	String	Name of the course.
courseCode	No	String	Human readable course code.
grades	No	List of Strings	Grade(s) for which the class is attended. The permitted vocabulary is from CEDS (Version 5) for the 'Entry Grade Level' element https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100
orgSourcedId	Yes	GUID Reference.	SourcedId of an org to which this course belongs.
subjects	No	List of Strings	Subject name(s) in human readable form. If the 'subjectCodes' attribute is present then the subjects and subjectCodes lists must have the same length and have order significanceThe vocabulary is from SCED (School Codes for the Exchange of Data) (Version 4) for the "Course Title" field: http://nces.ed.gov/forum/SCED.aspIf the value of the "Course Title" contains commas, then those commas must be removed.For example the "Course Title" for "SCED Course Code" "03210" is "Science, Technology and Society". This must be represented as "Science Technology and Society".
subjectCodes	No	String	Subject codes(s) in machine readable form. If the 'subjects' attribute is present then the subjects and subjectCodes lists must have the same length and have order significance.For deployments in the USA this vocabulary SHOULD be a School Courses for the Exchange of Data (SCED) code: http://nces.ed.gov/forum/SCED.asp[.](http://nces.ed.gov/forum/SCED.asp)

orgs.csv

This represents the Org dataset from OneRoster.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	Unique id for the organization. SourcedId is used in other files and must be unique across all organizations.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
name	Yes	String	Name of the organization.
type	Yes	Enumeration	See section 4.13.7 [OneRoster, 20a] for the enumeration list.
identifier	No	String	NCES ID National Center for Education Statistics) for the school/district.
parentSourcedId	No	GUID Reference.	SourcedId of an Org representing the Parent organization.

enrollments.csv

This represents the Enrollment dataset from OneRoster.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	Unique identifier of this enrollment.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
classSourcedId	Yes	GUID Reference.	SourcedId of the Class.
schoolSourcedId	Yes	GUID Reference.	SourcedId of an Org with type 'school'.
userSourcedId	Yes	GUID Reference.	SourcedId of the User.
role	Yes	Enumeration	See section 4.13.5 [OneRoster, 20a] for the enumeration list. The ONLY permitted values are: { administrator
primary	No	Enumeration	Permitted values: { "true"
beginDate	No	Date	The start date for the enrollment. This date must align with the associated academic session (term) identified in the class.
endDate	No	Date	The end date for the enrollment (exclusive). This date must align with the associated academic session (term) identified for the class.

users.csv

This represents the Users dataset from OneRoster.

Column Field Header	Required	Format	Description
sourcedId	Yes	GUID	Unique ID for the user. SourcedId is used in other files and must be unique across all users.
status	Yes for Delta	Enumeration	See section 4.13.8 [OneRoster, 20a] for the enumeration list.This MUST NOT be used for the Bulk mode.
dateLastModified	Yes for Delta	DateTime	The date that this record was last modified.This MUST NOT be used for the Bulk mode.
enabledUser	Yes	Enumeration	Permitted values: { "true"
orgSourcedIds	Yes	List of GUID References.	SourcedIds of the Orgs to which this user belongs.(Note in most cases, it is expected that users will belong to a single school).
role	Yes	Enumeration	See section 4.13.5 [OneRoster, 20a] for the full enumeration list.
username	Yes	String	User name.
userIds	No	List of Strings	External machine-readable ID (e.g. LDAP id, LTI id) for this user. The ID must be accompanied by a type to indicate the nature of the Identifier. The Type and ID values are enclosed in '{}' with a colon used to separate the values. If more than one userId is needed, use double quotes, and separate with commas (per RFC 4180).Examples:{LDAP:Id}"{LDAP:Id},{LTI:Id},{Fed:Id}"
givenName	Yes	String	User's first name.
familyName	Yes	String	User's surname.
middleName	No	String	User's middle name (s). If more than one then they are separated by a space.
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.
agentSourcedIds	No	List of GUID References	SourcedIds of the Users to which this user has a relationship. If multiple IDs are required then use double quotes and separate with commas.Note: In most cases this will be for indicating parental relationships.
grades	Only for student records	String	Grade(s) for which a user with role 'student' is enrolled. The permitted vocabulary is from CEDS (Version 5) for the 'Entry Grade Level' element https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100.
password	No	String	The password for the user. This may or may not be an encrypted string. If encrypted, the system's processing must be aware of the encryption method.

Updated on: 07/02/2024