PaginatedOneRosterCourseOutput

  • courses
    Type: array object[] · OneRosterCourseOutput[]
    required

    Array of course objects

    • courseCode
      Type: string
      required

      Code used to identify the course

    • dateLastModified
      Type: stringFormat: date-time
      required

      Timestamp of when the course was last modified

    • sourcedId
      Type: string
      required

      Unique identifier for the course

    • status
      Type: string · EntityStatusenum
      required

      Status of an entity in the system

      values
      • active
      • tobedeleted
      • inactive
    • title
      Type: string
      required

      Title of the course

    • grades
      Type: array string[] | null

      Array of grade levels associated with the course

    • metadata
      Type: object | null

      Additional metadata associated with the course

    • org
      Type: object · OneRosterGUIDRef nullable

      Organization the course belongs to

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

      Array of resources associated with the course

      A reference to another OneRoster entity

    • schoolYear
      Type: object · OneRosterGUIDRef nullable

      Academic session (school year) information

    • subjectCodes
      Type: array string[] | null

      Array of subject codes for the course

    • subjects
      Type: array string[] | null

      Array of subjects covered in the course

  • 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