OneRosterClassOutput

Class information in the OneRoster format

classCode
Type: string
required

Code used to identify the class
classType
Type: string
required

Type of class (scheduled, homeroom, etc.)
course
Type:
required

Course information associated with the class

Properties: 3
dateLastModified
Type: stringFormat: date-time
required

Timestamp of when the class was last modified
grades
Type: array of string
required

Array of grade levels associated with the class
periods
Type: array of string
required

Array of time periods when the class is scheduled
school
Type:
required

School information associated with the class

Properties: 3
sourcedId
Type: string
required

Unique identifier for the class
status
Type: enum
required

Status of an entity in the system

values
activetobedeletedinactive
subjects
Type: array of string
required

Array of subjects covered in the class
terms
Type:
required

Academic sessions (terms) associated with the class

Properties: 3
title
Type: string
required

Title or name of the class
location
Type: string | null

Physical location where the class is held
metadata
Type: object | null

Additional metadata associated with the class

Properties: 1
resources
Type:

Array of resources associated with the class

Properties: 3
subjectCodes
Type: array of string | null

Array of subject codes for the class