PaginatedOneRosterOrgOutput

  • limit
    Type: integer
    required

    Maximum number of items returned

  • offset
    Type: integer
    required

    Number of items skipped in the result set

  • orgs
    Type: array object[] · OneRosterOrgOutput[]
    required

    Array of organization objects

    Organization information in the OneRoster format

    • dateLastModified
      Type: stringFormat: date-time
      required

      Timestamp of when the organization was last modified

    • identifier
      Type: string
      required

      External identifier for the organization

    • name
      Type: string
      required

      Title of the organization

    • sourcedId
      Type: string
      required

      Unique identifier for the organization

    • status
      Type: stringenum
      required

      Status of an entity in the system

      values
      • active
      • tobedeleted
      • inactive
    • type
      Type: stringenum
      required

      Type of organization

      values
      • department
      • school
      • district
      • local
      • state
      • national
    • children
      Type: array object[] · OneRosterGUIDRef[]

      References to child organizations

      A reference to another OneRoster entity

    • metadata
      Type: object | null

      Additional metadata associated with the organization. Can contain custom fields including: privacyPolicyUrl (string), appStoreEnabled (boolean), consentManagementEnabled (boolean), credentialImportMode (string), cameraMicDefault (string: always, at_school, always_off).

    • parent
      Type: object · OneRosterGUIDRef nullable

      Reference to parent organization

  • total
    Type: integer
    required

    Total number of items available