PaginatedOneRosterEnrollmentOutput

  • enrollments
    Type: array object[] · OneRosterEnrollmentOutput[]
    required

    Array of enrollment objects

    • class
      Type: object · OneRosterGUIDRef
      required

      A reference to another OneRoster entity

    • dateLastModified
      Type: stringFormat: date-time
      required

      Timestamp of when the enrollment was last modified

    • primary
      Type: boolean
      required

      Whether this is the primary enrollment

    • role
      Type: string
      required

      Role of the user in this enrollment

    • school
      Type: object · OneRosterGUIDRef
      required

      A reference to another OneRoster entity

    • sourcedId
      Type: string
      required

      Unique identifier for the enrollment

    • status
      Type: string
      required

      Current status of the enrollment

    • user
      Type: object · OneRosterGUIDRef
      required

      A reference to another OneRoster entity

    • beginDate
      Type: stringFormat: date

      Start date of the enrollment

    • endDate
      Type: stringFormat: date

      End date of the enrollment

    • metadata
      Type: object

      Additional metadata associated with the enrollment

  • 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