PaginatedOneRosterClassOutput

  • classes
    Type: array object[] · OneRosterClassOutput[]
    required

    Array of class objects

    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: object · OneRosterGUIDRef
      required

      Course information associated with the class

    • dateLastModified
      Type: stringFormat: date-time
      required

      Timestamp of when the class was last modified

    • grades
      Type: array string[]
      required

      Array of grade levels associated with the class

    • periods
      Type: array string[]
      required

      Array of time periods when the class is scheduled

    • school
      Type: object · OneRosterGUIDRef
      required

      School information associated with the class

    • sourcedId
      Type: string
      required

      Unique identifier for the class

    • status
      Type: string · EntityStatusenum
      required

      Status of an entity in the system

      values
      • active
      • tobedeleted
      • inactive
    • subjects
      Type: array string[]
      required

      Array of subjects covered in the class

    • terms
      Type: array object[] · OneRosterGUIDRef[]
      required

      Academic sessions (terms) associated with the class

      A reference to another OneRoster entity

    • 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

    • resources
      Type: array object[] · OneRosterGUIDRef[]

      Array of resources associated with the class

      A reference to another OneRoster entity

    • subjectCodes
      Type: array string[] | null

      Array of subject codes for the class

  • limit
    Type: integer
    required

    Maximum number of items returned

  • offset
    Type: integer
    required

    Number of items skipped in the result set

  • total
    Type: integer
    required

    Total number of items available