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: string Format: 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: string · EntityStatusenum
      required

      Status of an entity in the system

      values
      • active
      • tobedeleted
      • inactive
    • type
      Type: string enum
      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

      Opaque key-value metadata for caller-defined data. Transitional: the 5 legacy config keys below are read-only and derived from the organization's deprecated config columns (not stored in metadata); they are re-exposed here for backward compatibility with consumers that read config from metadata, and will be removed once those consumers cut over to GET /orgs/{id}/config.

    • parent
      Type: object · OneRosterGUIDRefnullable

      Reference to parent organization

      A reference to another OneRoster entity

  • total
    Type: integer
    required

    Total number of items available