OneRail DOBO API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard DOBO API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: DOBO
paths:
  /v1/associated-locations/{organizationId}:
    post:
      x-exegesis-controller: Location
      summary: Get Associated Locations for an Organization
      operationId: getAssociatedLocations
      tags:
      - DOBO
      parameters:
      - name: organizationId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                originLocationIds:
                  type: array
                  items:
                    type: string
                  description: Optional list of origin location IDs to filter results.
                pagination:
                  type: object
                  properties:
                    offset:
                      type: integer
                      minimum: 0
                    limit:
                      type: integer
                      minimum: 1
                    sortby:
                      type: string
                    order:
                      type: string
                      enum:
                      - ASC
                      - DESC
                  description: Pagination and sorting options.
      responses:
        '200':
          description: List of associated origin location IDs
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    storeNumber:
                      type: string
                    msa:
                      type: string
                    address:
                      type: object
                      properties:
                        city:
                          type: string
                        label:
                          type: string
                        state:
                          type: string
                        county:
                          type: string
                        street:
                          type: string
                        street2:
                          type: string
                        district:
                          type: string
                        stateCode:
                          type: string
                        postalCode:
                          type: string
                        countryCode:
                          type: string
                        countryName:
                          type: string
                        houseNumber:
                          type: string
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Standard JWT bearer token used for authenticated OmniPoint users

        and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`

        and the token is validated using the shared Core access token secret.

        '
    ApiKey:
      type: apiKey
      in: header
      name: X-ONERAIL-API-KEY
      description: 'Shared secret key used for machine-to-machine integrations. Must be sent

        together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth

        record for that application.

        '
    AppId:
      type: apiKey
      in: header
      name: X-ONERAIL-APP-ID
      description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for

        machine-to-machine integrations. Both headers are required for ApiKey-based

        authentication.

        '
    OAuth:
      type: oauth2
      description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed

        integrations). Clients obtain tokens from their own IdP outside of this API

        and call endpoints with `Authorization: OAuth <access_token>`. The

        `authorizationUrl` and `tokenUrl` values below are placeholders only to

        satisfy the OpenAPI schema; this service does not call them directly and the

        real IdP URLs are configured via environment and introspection logic in code.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://dummy-unused-url.com
          tokenUrl: https://dummy-unused-url.com
          scopes: {}