Review the following information about the types of data, supported values, optionality, and ways data transferred using OneRoster APIs is used in Brightspace.
Academic Sessions
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for mapping to a Brightspace org unit |
Y
|
|
Status
|
active, tobedeleted
|
Create/update or delete the academic session
|
Y
|
|
DateLastModified
|
YYYY-MM-DDThh:mm:ss.sssZ
|
Ignored
|
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
Title
|
|
Org Unit Name and Org Unit Code
|
Y
|
|
StartDate
|
YYYY-MM-DD
|
Academic sessions are available to instructors when configuring grade items for export to the SIS. The dates are stored by IPSIS and are required when sending grades items to the SIS.
The academic session start date can be copied to the start dates of associated course offerings.
|
Y
|
|
EndDate
|
YYYY-MM-DD
|
Academic sessions are available to instructors when configuring grade items for export to the SIS. The dates are stored by IPSIS and are required when sending grades items to the SIS.
The academic session end date can be copied to the end dates of associated course offerings.
|
Y
|
|
Type
|
term, semester, schoolYear, gradingPeriod
|
Org Unit Type
Note: All SISs send all types
|
Y
|
|
Parent
|
|
Ignored
|
N
|
|
Children
|
|
Ignored
|
N
|
|
SchoolYear
|
|
Ignored
|
Y
|
Orgs
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for mapping to a Brightspace org unit |
Y
|
|
Status
|
active, tobedeleted
|
Create/update or delete the org unit
|
Y
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Ignored |
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
Name
|
|
Org Unit Name and Org Unit Code (if identifier not provided)
|
Y
|
|
Identifier
|
|
Org Unit Code (if provided)
|
N
|
|
Type
|
department, school, district, local, state, national
|
Org Unit Type
Note: Not all SISs send all types
|
Y
|
|
Parent
|
sourcedId of an org
|
Parent org unit. For district org units, there is no parent. For school org units, the parent is the district.
|
Not specifically required; however, without it, the org units will not be part of a hierarchy.
|
|
Children
|
|
Ignored
|
N
|
Courses
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for mapping to a Brightspace org unit (course template) |
Y
|
|
Status
|
active, tobedeleted
|
Create/update or delete the course template
|
Y
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Ignored |
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
Title
|
|
Org Unit Name and Org Unit Code (if courseCode not provided)
|
Y
|
|
SchoolYear
|
|
Ignored
|
N
|
|
CourseCode
|
|
Org Unit Code (if provided)
|
N
|
|
Grades
|
|
Ignored
|
N
|
|
Subjects
|
|
Ignored
|
N
|
|
Org
|
sourcedId of an org
|
Primarily this is the school org unit but can be SIS dependent
|
Y. Used to create org structure
|
|
SubjectCodes
|
|
Ignored |
N
|
|
Resources
|
|
Ignored
|
N
|
Classes
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for mapping to a Brightspace org unit (course offering) |
Y
|
|
Status
|
active, tobedeleted
|
Create/update or delete the course offering and section (set to inactive or delete based on IPSIS Administration configuration)
|
Y
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Ignored |
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
Title
|
|
Org Unit Name and Org Unit Code (if classCode is not provided)
|
Y
|
|
classCode
|
|
Org Unit Code (if provided)
|
N
|
|
classType
|
scheduled, homeroom
|
Ignored
|
Y
|
|
Location
|
|
Ignored
|
N
|
|
Grades
|
|
Ignored
|
N
|
| Subjects |
|
Ignored |
N |
| Course |
sourceId of a course |
Parent course template org unit |
Y |
| School |
sourceId of a course |
Parent school org unit |
Y |
| Terms |
List of sourceIds of academic sessions |
A single parent academic session org unit |
Y |
| subjectCodes |
|
Ignored |
N |
| Periods |
|
Ignored |
N |
| Resources |
|
Ignored |
N |
Users
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for mapping to a Brightspace use. If identifier is not provided, then sourcedId becomes Org Defined Id.
|
Y
|
|
Status
|
active, tobedeleted
|
Create/update or delete the user (set to inactive or delete based on IPSIS Administration Configuration
|
Y
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Ignored |
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
UserName
|
|
UserName
|
Y
|
|
UserIds
|
|
Ignored
|
N
|
|
EnabledUser
|
true, false
|
Active status of the user
|
Y
|
|
GivenName
|
|
Legal first name
|
Y
|
|
FamilyName
|
|
Legal last name
|
Y
|
|
MiddleName
|
|
Middle Name
|
N
|
|
Role
|
administrator, aide, guardian, parent, proctor, relative, student, teacher
|
Brightspace role In Org
|
Y
|
|
Identifier
|
|
OrgDefinedId
|
N
|
|
Email
|
|
External Email
|
N
|
|
Sms
|
|
Ignored
|
N
|
|
Phone
|
|
Ignored
|
N
|
|
Agents
|
List of sourceIds of users
|
Brightspace Parent & Guardian:
For user records with a role of student and which have agents that have a parent or guardian role, parent relationships are created.
|
N
|
|
Orgs
|
Upper org units
|
Enrollment into upper org units
|
Y
|
|
Grades
|
|
Ignored
|
N
|
|
Password
|
|
User password
|
N
|
Enrollments
| OneRoster |
Supported values |
Use in Brightspace platform |
Required |
|---|
|
SourcedId
|
|
Stored with IPSIS for tracking enrollment within a course |
Y
|
|
Status
|
active, tobedeleted
|
Enroll or unenroll the user from the course offering and section
|
Y
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Ignored |
Y
|
|
MetaData
|
|
Ignored
|
N
|
|
User
|
sourcedId of a user
|
User to enroll or unenroll
|
Y
|
|
Class
|
sourceId of a class
|
Course offering and section the user will be enrolled into or unenrolled out of.
|
Y
|
|
School
|
|
Ignored
|
Y
|
|
Role
|
administrator, proctor, student, teacher
|
Role of the user within the org unit
|
Y
|
|
Primary
|
|
Ignored
|
N
|
|
BeginDate
|
|
Ignored
|
N
|
|
EndDate
|
|
Ignored
|
N
|