> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List HOS Availabilities

> Get a paginated list of Hours of Service (HOS) Availabilities information accessible to your organization.



## OpenAPI

````yaml https://api.catenatelematics.com/v2/telematics/openapi.json get /v2/telematics/hos-availabilities
openapi: 3.1.0
info:
  title: Telematics Data Service - REST API
  description: Telematics Data Service REST API.
  version: 0.1.0
servers:
  - url: https://api.catenatelematics.com
    description: Catena Telematics API
security: []
tags:
  - name: Fleet Operations & Tracking
    description: >-
      Endpoints for tracking vehicles, trailers, assets, and trip activity —
      including locations, movements, and operational telemetry. Useful for
      monitoring utilization and real-time operational status.
  - name: Safety & Driver Behavior
    description: >-
      Endpoints that provide safety-related insights such as harsh braking,
      speeding, and other driver behavior events. Supports risk analysis and
      safety program automation.
  - name: Compliance & Regulation
    description: >-
      Endpoints covering regulated requirements including DVIR inspections,
      Hours of Service (HOS), violations, and IFTA fuel tax reporting. Helps
      organizations meet DOT/FMCSA and interstate regulatory obligations.
  - name: Maintenance & Vehicle Health
    description: >-
      Endpoints providing data for vehicle condition monitoring and maintenance
      workflows, such as DVIR defects and diagnostic sensor events. Enables
      early issue detection and reduced downtime.
  - name: Drivers & Users
    description: >-
      Endpoints related to driver and user identities, assignments, and
      operational context. Supports linking operational and safety data to
      specific individuals.
  - name: Reference Data (Supporting Tables)
    description: >-
      Lookup tables and enumerations that supply standardized codes, metadata,
      and classifications used across the API.
  - name: Analytics (deprecated)
    description: >-
      Endpoints providing analytical insights and aggregated data for vehicles,
      fleets, drivers, and trailers.
paths:
  /v2/telematics/hos-availabilities:
    get:
      tags:
        - Compliance & Regulation
        - Fleet Operations & Tracking
      summary: List HOS Availabilities
      description: >-
        Get a paginated list of Hours of Service (HOS) Availabilities
        information accessible to your organization.
      operationId: list_hos_availabilities
      parameters:
        - name: fleet_ids
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: string
                  format: uuid
                maxItems: 100
              - type: 'null'
            description: >-
              Limit results to specific fleets using Catena's fleet IDs. *For
              your own fleet identifiers, use `fleet_refs` instead* To specify
              multiple values, repeat the parameter for each value (e.g.,
              `?fleet_ids=id1&fleet_ids=id2`).
            title: Fleet Ids
          description: >-
            Limit results to specific fleets using Catena's fleet IDs. *For your
            own fleet identifiers, use `fleet_refs` instead* To specify multiple
            values, repeat the parameter for each value (e.g.,
            `?fleet_ids=id1&fleet_ids=id2`).
        - name: fleet_refs
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: string
                maxItems: 100
              - type: 'null'
            description: >-
              Limit results to specific fleets using your organization's fleet
              reference identifiers. To specify multiple values, repeat the
              parameter for each value (e.g.,
              `?fleet_refs=ref1&fleet_refs=ref2`).
            title: Fleet Refs
          description: >-
            Limit results to specific fleets using your organization's fleet
            reference identifiers. To specify multiple values, repeat the
            parameter for each value (e.g., `?fleet_refs=ref1&fleet_refs=ref2`).
        - name: connection_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: >-
              Limit results to a specific provider connection. This is the UUID
              assigned by Catena when your fleet connects to a TSP.
            title: Connection Id
          description: >-
            Limit results to a specific provider connection. This is the UUID
            assigned by Catena when your fleet connects to a TSP.
        - name: include_source_data
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Include the raw data from the telematics provider. *Useful for
              auditing or accessing fields not normalized by Catena*
            default: false
            title: Include Source Data
          description: >-
            Include the raw data from the telematics provider. *Useful for
            auditing or accessing fields not normalized by Catena*
        - name: driver_ids
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: string
                  format: uuid
                maxItems: 100
              - type: 'null'
            description: >-
              Limit results to specific drivers. **Maximum:** 100 IDs To specify
              multiple values, repeat the parameter for each value (e.g.,
              `?driver_ids=id1&driver_ids=id2`).
            title: Driver Ids
          description: >-
            Limit results to specific drivers. **Maximum:** 100 IDs To specify
            multiple values, repeat the parameter for each value (e.g.,
            `?driver_ids=id1&driver_ids=id2`).
        - name: vehicle_ids
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  type: string
                  format: uuid
                maxItems: 100
              - type: 'null'
            description: >-
              Limit results to specific vehicles. **Maximum:** 100 IDs To
              specify multiple values, repeat the parameter for each value
              (e.g., `?vehicle_ids=id1&vehicle_ids=id2`).
            title: Vehicle Ids
          description: >-
            Limit results to specific vehicles. **Maximum:** 100 IDs To specify
            multiple values, repeat the parameter for each value (e.g.,
            `?vehicle_ids=id1&vehicle_ids=id2`).
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              The name of the field to sort results by. If not provided, results
              will be ordered by `occurred_at`. 
            title: Sort By
          description: >-
            The name of the field to sort results by. If not provided, results
            will be ordered by `occurred_at`. 
        - name: sort_order
          in: query
          required: false
          schema:
            enum:
              - asc
              - desc
            type: string
            description: >-
              The order of sorting, either `asc` for ascending or `desc` for
              descending. Defaults to `asc` if `sort_by` is provided without
              `sort_order`.
            default: asc
            title: Sort Order
          description: >-
            The order of sorting, either `asc` for ascending or `desc` for
            descending. Defaults to `asc` if `sort_by` is provided without
            `sort_order`.
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Cursor for the next page
            title: Cursor
          description: Cursor for the next page
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Page size
            default: 300
            title: Size
          description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_CursorPage_HosAvailabilityRead_'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MethodNotAllowed'
          description: Method Not Allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conflict'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplementedResponse'
          description: Not Implemented
      security:
        - Bearer:
            - telematics:read
components:
  schemas:
    _CursorPage_HosAvailabilityRead_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/HosAvailabilityRead'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        current_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page
          description: Cursor to refetch the current page
        current_page_backwards:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page Backwards
          description: Cursor to refetch the current page starting from the last item
        previous_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous Page
          description: Cursor for the previous page
        next_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page
          description: Cursor for the next page
      type: object
      required:
        - items
        - total
      title: _CursorPage[HosAvailabilityRead]
    BadRequest:
      properties:
        code:
          type: integer
          title: Code
          default: 400
        message:
          type: string
          title: Message
          default: Bad Request
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: BadRequest
    Unauthorized:
      properties:
        code:
          type: integer
          title: Code
          default: 401
        message:
          type: string
          title: Message
          default: Unauthorized
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Unauthorized
    Forbidden:
      properties:
        code:
          type: integer
          title: Code
          default: 403
        message:
          type: string
          title: Message
          default: Forbidden
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Forbidden
    NotFound:
      properties:
        code:
          type: integer
          title: Code
          default: 404
        message:
          type: string
          title: Message
          default: Not Found
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: NotFound
    MethodNotAllowed:
      properties:
        code:
          type: integer
          title: Code
          default: 405
        message:
          type: string
          title: Message
          default: Method Not Allowed
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: MethodNotAllowed
    Conflict:
      properties:
        code:
          type: integer
          title: Code
          default: 409
        message:
          type: string
          title: Message
          default: Conflict
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: Conflict
    UnprocessableEntity:
      properties:
        code:
          type: integer
          title: Code
          default: 422
        message:
          type: string
          title: Message
          default: Invalid Request Body
        detail:
          anyOf:
            - items:
                $ref: '#/components/schemas/ValidationErrorDetail'
              type: array
            - type: 'null'
          title: Detail
      type: object
      title: UnprocessableEntity
    TooManyRequests:
      properties:
        code:
          type: integer
          title: Code
          default: 429
        message:
          type: string
          title: Message
          default: Too Many Requests
        detail:
          anyOf:
            - $ref: '#/components/schemas/RetryAfterDetail'
            - type: 'null'
      type: object
      title: TooManyRequests
    InternalServerError:
      properties:
        message:
          type: string
          title: Message
          default: Internal Server Error
      type: object
      title: InternalServerError
    NotImplementedResponse:
      properties:
        code:
          type: integer
          title: Code
          default: 501
        message:
          type: string
          title: Message
          default: Not Implemented
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
      type: object
      title: NotImplementedResponse
    HosAvailabilityRead:
      properties:
        fleet_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Fleet Id
          description: Internal fleet identifier.
        fleet_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Fleet Ref
          description: External fleet reference in the partner system.
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier of the record at Catena Telematics.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: >-
            Immutable: The datetime the record was ingested into Catena
            Telematics.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The dateime the record was last modified in Catena Telematics.
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
          description: >-
            The datetime the record was logically deleted from Catena
            Telematics.
        connection_id:
          type: string
          format: uuid
          title: Connection Id
          description: >-
            Unique identifier of the connection at Catena Telematics through
            which this record was ingested. A connection represents a Fleet/TSP
            pairing.
        tsp_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Tsp Id
          description: >-
            Unique identifier of the TSP at Catena Telematics from which this
            record was ingested.
        tsp_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Tsp Slug
          description: >-
            Human readable slug of the TSP at Catena Telematics from which this
            record was ingested.
        source_name:
          $ref: '#/components/schemas/TspEnum'
          description: >-
            The underlying telematics platform that provided this data (e.g.,
            `samsara`, `motive`, `hos247`). Note: Some platforms like `hos247`
            offer white-labeling, so multiple TSPs may share the same
            source_name — use `tsp_id` or `tsp_slug` to identify the specific
            ELD provider.
        source_data:
          additionalProperties: true
          type: object
          title: Source Data
          description: >-
            Raw source payload as ingested from the TSP. **Note: use it for
            audit/debugging.**
        source_id:
          type: string
          title: Source Id
          description: >-
            Unique identifier of the record in the TSP. **Note: we generate a
            unique composite key based on available fields if the TSP does not
            provide an unique ID.**
        source_data_hash:
          type: string
          maxLength: 64
          title: Source Data Hash
          description: >-
            SHA-256 hash of the source data payload. **Note: we use it
            internally for idempotence and deduplication.**
        occurred_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Occurred At
          description: >-
            Datetime of when the underlying event/observation occurred, as
            reported by the TSP, or the moment it was ingested by us if not
            available in the source data.
        execution_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Execution Id
          description: >-
            Unique identifier for the execution that ingested this record into
            Catena Telematics. **Note: useful for tracing.**
        schedule_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Schedule Id
          description: >-
            Unique identifier for schedule that triggered this record's
            execution. **Note: useful for tracing.**
        extras:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extras
          description: >-
            Additional data available in the TSP (e.g., we may have
            `external_id`, `provider_resource_id`, etc. — this field captures
            all those extra attributes in a flexible way).
        driver_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Driver Id
          description: Internal driver identifier (Catena FK)
        vehicle_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Vehicle Id
          description: Internal vehicle identifier (Catena FK), if mapped
        hos_ruleset_code:
          anyOf:
            - $ref: '#/components/schemas/HosRulesetCodeEnum'
            - type: 'null'
          description: Normalized HOS ruleset code
        duty_status_code:
          anyOf:
            - $ref: '#/components/schemas/DutyStatusCodeEnum'
            - type: 'null'
          description: >-
            Normalized duty status: OFF (off-duty), SB (sleeper berth), D
            (driving), ON (on-duty), YM (yard move), PC (personal conveyance)
        cycle_started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cycle Started At
          description: Start of the current cycle window
        cycle_ends_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cycle Ends At
          description: End of the current cycle window
        available_drive_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Drive Seconds
          description: Integer seconds of driving time remaining in the current shift
        available_shift_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Shift Seconds
          description: >-
            Integer seconds of on-duty/workday time remaining in the current
            shift
        available_cycle_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Cycle Seconds
          description: Integer seconds remaining in the ruleset cycle window
        available_tomorrow_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Tomorrow Seconds
          description: Forecasted available integer seconds for the following day
        available_day2_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Day2 Seconds
          description: Forecasted available integer seconds two days out
        available_day3_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Available Day3 Seconds
          description: Forecasted available integer seconds three days out
        forecast_horizon_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Forecast Horizon Days
          description: Maximum forecast horizon included in this snapshot (days)
        time_until_break_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Time Until Break Seconds
          description: >-
            Integer seconds until the next required break begins (e.g., 900 = 15
            minutes). Use 0 if due now; null if not applicable or unknown.
        rest_remaining_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rest Remaining Seconds
          description: >-
            Integer seconds remaining in the currently required rest window.
            Null if no rest is required or unknown.
        cycle_violation_duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cycle Violation Duration Seconds
          description: >-
            Integer seconds accrued beyond the ruleset cycle limit (violation
            duration). Use 0 if not in violation; null if unknown.
        shift_driving_violation_duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Shift Driving Violation Duration Seconds
          description: >-
            Integer seconds accrued beyond the shift driving limit (violation
            duration). Use 0 if not in violation; null if unknown.
        shift_ends_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Shift Ends At
          description: Projected end of the current shift/workday
        next_break_due_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next Break Due At
          description: Timestamp when the next required break must begin
        next_10hr_reset_eligible_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next 10Hr Reset Eligible At
          description: Earliest timestamp the driver can begin a 10-hour reset
        next_34hr_reset_eligible_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Next 34Hr Reset Eligible At
          description: Earliest timestamp the driver can begin a 34-hour reset (US)
        is_personal_conveyance_applied:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Personal Conveyance Applied
          description: True indicates whether personal conveyance is currently applied
        is_yard_move_applied:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Yard Move Applied
          description: True indicates whether yard move is currently applied
        is_adverse_driving_exemption_available:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Adverse Driving Exemption Available
          description: True indicates whether the adverse driving exemption is available
        is_adverse_driving_applied:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Adverse Driving Applied
          description: >-
            True indicates whether the adverse driving exemption is currently
            applied
        is_meal_break_required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Meal Break Required
          description: >-
            True indicates whether the ruleset requires a meal break for this
            shift/day
        meal_break_due_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Meal Break Due At
          description: Timestamp when the required meal break must start
        meal_break_min_duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Meal Break Min Duration Seconds
          description: Minimum required meal/rest break duration (integer seconds)
        meal_break_time_until_due_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Meal Break Time Until Due Seconds
          description: Integer seconds until the required meal break begins
        is_split_sleep_applied:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Split Sleep Applied
          description: >-
            True indicates whether a split sleeper-berth period is currently in
            progress
        is_sleeper_eligible:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Sleeper Eligible
          description: >-
            True indicates whether the active ruleset permits sleeper-berth
            split
        sleeper_required_remaining_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sleeper Required Remaining Seconds
          description: Integer seconds still required in sleeper to satisfy the split
        sleeper_split_window_ends_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Sleeper Split Window Ends At
          description: Deadline by which the complementary sleeper-berth period must occur
        is_cycle_applicable:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Cycle Applicable
          description: >-
            True indicates whether cycle limits constrain availability for this
            ruleset/snapshot
        exception_codes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Exception Codes
          description: List of active HOS exception codes
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
          description: Human-readable notes from TSP about clocks and exceptions
      type: object
      required:
        - fleet_id
        - id
        - created_at
        - updated_at
        - connection_id
        - source_name
        - source_id
        - source_data_hash
      title: HosAvailabilityRead
      description: HosAvailability model for API responses
    ValidationErrorDetail:
      properties:
        path:
          type: string
          title: Path
        input:
          type: string
          title: Input
        message:
          type: string
          title: Message
        error_type:
          type: string
          title: Error Type
      type: object
      required:
        - path
        - input
        - message
        - error_type
      title: ValidationErrorDetail
    RetryAfterDetail:
      properties:
        retry_after_seconds:
          type: integer
          title: Retry After Seconds
        message:
          type: string
          title: Message
      type: object
      required:
        - retry_after_seconds
        - message
      title: RetryAfterDetail
    TspEnum:
      type: string
      enum:
        - ada
        - ai_eld
        - air_eld
        - alfa_eld
        - alpha_eld
        - als
        - anytrek_pro
        - anytrek_classic
        - apex_eld
        - apollo
        - apollocloud
        - ascend
        - att
        - awaregps
        - azuga
        - bigroad
        - bluehorse_eld
        - blueinktech
        - bouncie
        - budgetgps
        - catena_simulator
        - captain_eld
        - carrier_lynx
        - club_eld
        - counting_trucks_eld
        - cyntrx
        - digital_eld
        - dragon_eld
        - drive_hos
        - drive_hos_v2
        - driver_tech
        - dsg_elogs
        - dynamic_eld
        - eighteighteight_eld
        - eld_88
        - eld_books
        - eld_mandate
        - eld_mandate_prime
        - eroad
        - eva_eld
        - evo_eld
        - expressway_eld
        - extreme_eld
        - ezlogz
        - ez_lynk
        - factor_eld
        - firstgate
        - fleetcomplete
        - fleetcompletehub
        - fleethunt
        - fleetpulse
        - fleetsharp
        - fleetup
        - fm
        - forwardthinking
        - forza_eld
        - geotab
        - gpsinsight
        - gpstab
        - gpstrackit
        - grand_eld
        - greenlight
        - groundhog
        - hcss
        - hos247
        - hutch
        - intellishift
        - ironman_eld
        - isaac
        - jjkeller
        - kinexaiot
        - knight_eld
        - konexial
        - lioneight
        - linxup
        - loop_eld
        - lucid_eld
        - luna_eld
        - lytx
        - lytxv3
        - mapon
        - matrack
        - maven
        - mdm_eld
        - mobilefleet
        - moonlight_eld
        - motion_eld
        - motive
        - my_drivebook
        - my_logs_eld
        - nero
        - netradyne
        - new_eld_world
        - nextgen_eld
        - nextraq
        - omnitracs
        - onestep
        - ontime_eld
        - optima
        - orbcomm
        - orient_eld
        - panda_eld
        - payd
        - peak_eld
        - peoplenet
        - phillips_connect
        - phoenix
        - pop_eld
        - prologs
        - proride_eld
        - qualitylogs_eld
        - randmcnally
        - rastrac
        - raven
        - redfox
        - regulog_eld
        - ridehub
        - roadeazy
        - rock_eld
        - rollingtrans
        - routemate
        - royal_eld
        - safelane
        - samsara
        - selectivedrive
        - simba_eld
        - skybitz
        - smart_elds
        - sparkle_eld
        - spireon
        - sun_eld
        - surfsight
        - swift
        - switchboard
        - synergy_eld
        - teletracnavman
        - teletracnavman_director
        - telogis
        - tenna
        - thermo_king
        - think
        - tive
        - topcompliance_eld
        - traccar
        - trackease_eld
        - trackpro
        - traclog
        - transflo
        - trimble
        - truckford
        - truckspy
        - truckx
        - trueroad_eld
        - tt
        - txt_eld
        - us_fast_eld
        - verizon_connect
        - vista_eld
        - vistracks
        - vlog_eld
        - vulcansols_eld
        - wialon
        - webfleet
        - xplore_eld
        - zigzag_eld
        - zms_eld
        - zonar
        - zubie
      title: TspEnum
      description: Enum for TSPs
    HosRulesetCodeEnum:
      type: string
      enum:
        - US_INT_PROP_60_7
        - US_INT_PROP_60_7_BIG
        - US_INT_PROP_60_7_BIG_SLP
        - US_INT_PROP_60_7_NORST
        - US_INT_PROP_60_7_NORST_SLP
        - US_INT_PROP_60_7_NOBRK
        - US_INT_PROP_60_7_NOBRK_BIG
        - US_INT_PROP_60_7_NOBRK_BIG_SLP
        - US_INT_PROP_60_7_NOBRK_SLP
        - US_INT_PROP_60_7_SH
        - US_INT_PROP_60_7_SH_NORST
        - US_INT_PROP_70_8
        - US_INT_PROP_70_8_BIG
        - US_INT_PROP_70_8_BIG_SLP
        - US_INT_PROP_70_8_NORST
        - US_INT_PROP_70_8_NORST_SLP
        - US_INT_PROP_70_8_NOBRK
        - US_INT_PROP_70_8_NOBRK_BIG
        - US_INT_PROP_70_8_NOBRK_BIG_SLP
        - US_INT_PROP_70_8_NOBRK_SLP
        - US_INT_PROP_70_8_SH
        - US_INT_PROP_70_8_SH_14H
        - US_INT_PROP_70_8_SH_NORST
        - US_INT_PROP_SH_14H
        - US_INT_PAX_60_7
        - US_INT_PAX_60_7_SH
        - US_INT_PAX_70_8
        - US_INT_PAX_70_8_SH
        - US_INT_SALESP
        - US_INT_SALESP_NCDL_SH
        - US_INT_OILTR_60_7
        - US_INT_OILTR_70_8
        - US_INT_OILWL_60_7
        - US_INT_OILWL_70_8
        - US_INT_RAIL_EX
        - US_INT_PROP_SLPVAR
        - US_INT_PROP_60_7_SLPVAR
        - US_INT_PROP_70_8_SLPVAR
        - US_INT_CARRIER_EX
        - US_INT_NOHOS_7
        - US_INT_NOHOS_8
        - US_TX_INTRA_PROP_70_7
        - US_TX_INTRA_SH_70_7
        - US_TX_INTRA_SH_70_8
        - US_CA_INTRA_PROP_80_8
        - US_CA_INTRA_PAX_80_8
        - US_CA_INTRA_FARM_112_8
        - US_CA_INTRA_FARM_BRK
        - US_CA_INTRA_FLAM_80_8
        - US_CA_INTRA_FLAM_BRK
        - US_CA_INTRA_SCH_80_8
        - US_CA_INTRA_SCH_BRK
        - US_AK_INTRA_PROP_70_7
        - US_AK_INTRA_PROP_80_8
        - US_AK_INTRA_PAX_70_7
        - US_AK_INTRA_PAX_80_8
        - US_AK_INTRA_PROP_70_7_SLP
        - US_AK_INTRA_PROP_80_8_SLP
        - US_FL_INTRA_PROP_70_7
        - US_FL_INTRA_PROP_80_8
        - US_FL_INTRA_SH_70_7
        - US_FL_INTRA_SH_80_8
        - US_OR_INTRA_PROP_70_7
        - US_OR_INTRA_PROP_80_8
        - US_MD_INTRA_SH_70_7
        - US_MD_INTRA_SH_80_8
        - US_NE_INTRA_PROP_70_7
        - US_NE_INTRA_PROP_80_8
        - US_NC_INTRA_PROP_70_7
        - US_NC_INTRA_PROP_80_8
        - US_ND_INTRA_PROP_70_7
        - US_ND_INTRA_SH_70_7
        - US_SC_INTRA_PROP_70_7
        - US_SC_INTRA_PROP_80_8
        - US_WA_INTRA_PROP_70_7
        - US_WA_INTRA_PROP_80_8
        - US_WI_INTRA_PROP_70_7
        - US_WI_INTRA_PROP_80_8
        - CA_FED_C1_70_7
        - CA_FED_C2_120_14
        - CA_FED_C1_TEAM
        - CA_FED_C2_TEAM
        - CA_FED_NOHOS
        - CA_N60_C1_80_7
        - CA_N60_C2_120_14
        - CA_N60_C1_TEAM
        - CA_N60_C2_TEAM
        - CA_N60_NOHOS
        - CA_N60_OIL
        - CA_N60_OIL_TEAM
        - CA_AB_PROV_PROP_70_7
        - CA_SK_PROV_PROP_70_7
        - CA_SK_PROV_FERT_EX
        - CA_BC_PROV_LOG
        - CA_S60_OIL
        - CA_OIL_TEAM
        - US_INT_OILTR_60_7_BIG
        - US_INT_OILTR_60_7_BIG_SLP
        - US_INT_OILTR_60_7_SLP
        - US_INT_OILTR_70_8_BIG
        - US_INT_OILTR_70_8_BIG_SLP
        - US_INT_OILTR_70_8_SLP
        - US_CA_INTRA_OILTR_80_8
        - US_CA_INTRA_OILTR_PROP
        - US_INT_OILTR_60_7_NOBRK
        - US_INT_OILTR_60_7_NOBRK_BIG
        - US_INT_OILTR_60_7_NOBRK_BIG_SLP
        - US_INT_OILTR_60_7_NOBRK_SLP
        - US_INT_OILTR_70_8_NOBRK
        - US_INT_OILTR_70_8_NOBRK_BIG
        - US_INT_OILTR_70_8_NOBRK_BIG_SLP
        - US_INT_OILTR_70_8_NOBRK_SLP
        - US_INT_OILTR_SH_12H
        - US_INT_OILTR_SH_14H
        - US_INT_OILTR_70_8_SH_12H
        - US_INT_OILTR_70_8_SH_14H
        - US_TX_INTRA_OILTR_70_7
        - US_INT_OILWL_60_7_BIG
        - US_INT_OILWL_60_7_BIG_SLP
        - US_INT_OILWL_60_7_SLP
        - US_INT_OILWL_70_8_BIG
        - US_INT_OILWL_70_8_BIG_SLP
        - US_INT_OILWL_70_8_SLP
        - US_CA_INTRA_OILWL_80_8
        - US_CA_INTRA_OILWL_PROP
        - US_INT_OILWL_60_7_NOBRK
        - US_INT_OILWL_60_7_NOBRK_BIG
        - US_INT_OILWL_60_7_NOBRK_BIG_SLP
        - US_INT_OILWL_60_7_NOBRK_SLP
        - US_INT_OILWL_70_8_NOBRK
        - US_INT_OILWL_70_8_NOBRK_BIG
        - US_INT_OILWL_70_8_NOBRK_BIG_SLP
        - US_INT_OILWL_70_8_NOBRK_SLP
        - US_TX_INTRA_OILWL_70_7
      title: HosRulesetCodeEnum
      description: Enum for HOS ruleset codes
    DutyStatusCodeEnum:
      type: string
      enum:
        - 'OFF'
        - SB
        - D
        - 'ON'
        - PC
        - YM
        - INT
        - WT
      title: DutyStatusCodeEnum
      description: Enum for duty status codes
  securitySchemes:
    Bearer:
      type: oauth2
      flows:
        clientCredentials:
          refreshUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
          scopes: {}
          tokenUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
        authorizationCode:
          refreshUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token
          scopes: {}
          authorizationUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.catenatelematics.com/realms/catena/protocol/openid-connect/token

````