Optibus Regions API

openapi: 3.0.0
info:
  title: Optibus Operations Driver Absences Regions API
  version: 2.8.17
  description: '**Welcome to the Optibus Operations API documentation!**


    Optibus Operations is a cloud-based software solution that enables public transport providers to optimize their operations, planning, and scheduling. Our API provides programmatic access to Optibus Operations'' functionality, allowing you to integrate it with your own applications and systems.



    '
  license:
    name: Optibus Ltd, All rights reserved
  contact: {}
servers:
- url: https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co
  description: Contact your Optibus Customer Success Manager for the actual baseURL and API credentials to use.
tags:
- name: Regions
paths:
  /v1/regions:
    get:
      operationId: GetRegions
      responses:
        '200':
          description: Regions data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRegionsResponse'
      description: Returns the configured organizational Regions including the corresponding Units for each Region.
      summary: List regions
      tags:
      - Regions
      security:
      - api_key: []
      parameters: []
components:
  schemas:
    Region:
      allOf:
      - $ref: '#/components/schemas/Pick_Depot.name-or-isArchived_'
      - properties:
          units:
            items:
              allOf:
              - $ref: '#/components/schemas/Pick_OpUnit.code-or-name-or-isArchived_'
              - properties:
                  uuid:
                    type: string
                required:
                - uuid
                type: object
            type: array
          uuid:
            type: string
        required:
        - units
        - uuid
        type: object
    Pick_Depot.name-or-isArchived_:
      properties:
        name:
          type: string
        isArchived:
          type: boolean
      required:
      - name
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    Pick_OpUnit.code-or-name-or-isArchived_:
      properties:
        name:
          type: string
        isArchived:
          type: boolean
        code:
          type: string
      required:
      - name
      - code
      type: object
      description: From T, pick a set of properties whose keys are in the union K
    GetRegionsResponse:
      items:
        $ref: '#/components/schemas/Region'
      type: array
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: General API Info
  tags:
  - Authentication
  - Versioning
- name: Use case guides
  tags:
  - HR System Integration Guides
  - Fleet Management System Integration Guides
  - Operational Plan Query Guides
  - Custom Driver App Notification Action Guide
- name: Client preferences
  tags:
  - Preferences
- name: Resource Management
  tags:
  - Regions
  - Drivers
  - Driver Absences
  - Driver Employment Periods
  - Driver Custom Attributes
  - Driver Groups
  - Vehicles
  - Vehicle Downtimes
  - Vehicle Custom Attributes
- name: Operations Management
  tags:
  - Roster
  - Operational Plan
  - Tasks
  - Stops
  - Signing Times
- name: Work & Payroll
  tags:
  - Work Entities
  - Payroll
  - Statistics
- name: Private Hires
  tags:
  - Private Hires
- name: Driver App Integration
  tags:
  - Driver App Notifications
- name: Event Webhooks
  tags:
  - Event Webhooks
- name: Data Ingestion
  tags:
  - Tacho Ingestion
- name: Deprecated API Endpoints
  tags:
  - Drivers (Deprecated)
  - Vehicles (Deprecated)
  - Operational Plan (Deprecated)
- name: Changelog
  tags:
  - Changelog