openapi: 3.2.0
info:
  title: Kelowna Production Reclaimed Water Data API
  version: v1
tags:
- name: ReclaimedWaterData
paths:
  /Hardware/ReclaimedWaterData/Status:
    get:
      tags:
      - ReclaimedWaterData
      summary: Returns recent statuses for a given reclaimed water unit ID
      parameters:
      - name: reclaimedWaterUnitId
        in: query
        description: The ID of the reclaimed water unit whose statuses to return.
        schema:
          type: integer
          format: int32
      - name: maxResults
        in: query
        description: Maximum number of results to return. Defaults to 10.
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReclaimedWaterStatus'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReclaimedWaterStatus'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReclaimedWaterStatus'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: getHardwareReclaimedWaterDataStatus
      x-operation-id-source: derived
  /Hardware/ReclaimedWaterData/CO2InjectionReadings:
    get:
      tags:
      - ReclaimedWaterData
      summary: Returns recent CO2 injection readings for a given reclaimed water unit ID
      description: Readings are translated back into the input format defined by the RW team.
      parameters:
      - name: reclaimedWaterUnitId
        in: query
        description: The ID of the reclaimed water unit whose data to return.
        schema:
          type: integer
          format: int32
      - name: maxResults
        in: query
        description: Maximum number of results to return. Defaults to 10.
        schema:
          type: integer
          format: int32
          default: 10
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CO2ReadingResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CO2ReadingResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CO2ReadingResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: getHardwareReclaimedWaterDataCO2InjectionReadings
      x-operation-id-source: derived
components:
  schemas:
    CO2ReadingResponse:
      type: object
      properties:
        reclaimedWaterCO2ReadingId:
          type: integer
          format: int32
        reclaimedWaterUnitId:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
        pT_101:
          type:
          - number
          - 'null'
          format: float
        pT_201:
          type:
          - number
          - 'null'
          format: float
        pT_202:
          type:
          - number
          - 'null'
          format: float
        tT_101:
          type:
          - number
          - 'null'
          format: float
        dT_101:
          type:
          - number
          - 'null'
          format: float
        iT_101:
          type:
          - number
          - 'null'
          format: float
        cO2_Flowrate:
          type:
          - number
          - 'null'
          format: float
        cO2_Temp:
          type:
          - number
          - 'null'
          format: float
      additionalProperties: false
    ReclaimedWaterStatus:
      type: object
      properties:
        reclaimedWaterStatusId:
          type: integer
          format: int32
        reclaimedWaterUnitId:
          type: integer
          format: int32
        timestamp:
          type: string
          format: date-time
        tankLevelPercent:
          type:
          - number
          - 'null'
          format: float
        ambientTemperatureC:
          type:
          - number
          - 'null'
          format: float
        systemStatus:
          type:
          - string
          - 'null'
        wasCO2Active:
          type:
          - boolean
          - 'null'
        wasPumpActive:
          type:
          - boolean
          - 'null'
        httpErrorCount:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
  securitySchemes:
    OrcaAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    MyCCAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    M2MAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}