openapi: 3.2.0
info:
  title: Kelowna Production Cellular - Reclaimed Water API
  version: v1
tags:
- name: Cellular - Reclaimed Water
paths:
  /Cellular/ReclaimedWater/Data/InflowOutflowReadings:
    post:
      tags:
      - Cellular - Reclaimed Water
      parameters:
      - name: x-soracom-imsi
        in: header
        required: true
        example: '310170845466094'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InflowOutflowDeviceReadings'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InflowOutflowDeviceReadings'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InflowOutflowDeviceReadings'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      - OrcaAuth:
        - applicationId
        - roles
      summary: Create cellular reclaimed water data inflow outflow readings
      x-summary-source: derived
      operationId: postCellularReclaimedWaterDataInflowOutflowReadings
      x-operation-id-source: derived
  /Cellular/ReclaimedWater/Data/CO2InjectionReadings:
    post:
      tags:
      - Cellular - Reclaimed Water
      summary: Uploads new CO2 injection readings for a reclaimed water unit
      parameters:
      - name: x-soracom-imsi
        in: header
        required: true
        example: '310170845466094'
      requestBody:
        description: The readings to save
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CO2Readings'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CO2Readings'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CO2Readings'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      - OrcaAuth:
        - applicationId
        - roles
      operationId: postCellularReclaimedWaterDataCO2InjectionReadings
      x-operation-id-source: derived
  /Cellular/ReclaimedWater/Data/Statuses:
    post:
      tags:
      - Cellular - Reclaimed Water
      summary: Uploads new system status readings for a reclaimed water unit
      parameters:
      - name: x-soracom-imsi
        in: header
        required: true
        example: '310170845466094'
      requestBody:
        description: The readings to save
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/StatusReadings'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/StatusReadings'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/StatusReadings'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      - OrcaAuth:
        - applicationId
        - roles
      operationId: postCellularReclaimedWaterDataStatuses
      x-operation-id-source: derived
  /Cellular/ReclaimedWater/Data/MassReadings:
    post:
      tags:
      - Cellular - Reclaimed Water
      summary: Uploads new mass readings for a reclaimed water unit
      parameters:
      - name: x-soracom-imsi
        in: header
        required: true
        example: '310170845466094'
      requestBody:
        description: The readings to save
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MassReadings'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MassReadings'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/MassReadings'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      - OrcaAuth:
        - applicationId
        - roles
      operationId: postCellularReclaimedWaterDataMassReadings
      x-operation-id-source: derived
  /Cellular/ReclaimedWater/Data/Alarm:
    post:
      tags:
      - Cellular - Reclaimed Water
      summary: Adds an alarm to the DB and sends an email notification to the RW team
      parameters:
      - name: x-soracom-imsi
        in: header
        required: true
        example: '310170845466094'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlarmArgs'
          text/json:
            schema:
              $ref: '#/components/schemas/AlarmArgs'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AlarmArgs'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ReadingsProcessedResponse'
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      - OrcaAuth:
        - applicationId
        - roles
      operationId: postCellularReclaimedWaterDataAlarm
      x-operation-id-source: derived
components:
  schemas:
    AlarmArgs:
      type: object
      properties:
        status_ALARM:
          type: integer
          format: int32
        date:
          type: string
          format: date-time
      additionalProperties: false
    StatusReadings:
      type: object
      properties:
        datetime:
          type: string
          format: date-time
        tank_Level:
          type: number
          format: float
        ambient_Temp:
          type: number
          format: float
        system_Status_Indicator:
          type:
          - string
          - 'null'
        cO2_Indicator:
          type:
          - boolean
          - 'null'
        pump_Power_Indicator:
          type:
          - boolean
          - 'null'
        httP_Error:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    MassReadings:
      type: object
      properties:
        datetime:
          type: string
          format: date-time
        rW_SG:
          type: number
          format: float
        rW_USED:
          type: number
          format: float
        voL_UNTRTD_ENTERING:
          type: number
          format: float
        sG_SOLIDS:
          type: number
          format: float
        neW_RW_SOLIDS_FRCTNS:
          type: number
          format: float
        neW_RW_SOLIDS:
          type: number
          format: float
        trgT_CO2_MASS:
          type: number
          format: float
        trgT_CO2_VOL:
          type: number
          format: float
        density_Sensor_1:
          type: number
          format: float
        density_Sensor_2:
          type: number
          format: float
        cO2_Daily_SP:
          type: number
          format: float
        cO2_Added_Kg:
          type: number
          format: float
        cO2_Added_Litres:
          type: number
          format: float
      additionalProperties: false
    InflowOutflowDeviceReadings:
      type: object
      properties:
        date:
          type: string
          format: date-time
        pump_Code:
          type: integer
          format: int32
        pump_Runtime:
          type: number
          format: double
        pump_Volume:
          type: number
          format: double
      additionalProperties: false
    CO2Readings:
      type: object
      properties:
        datetime:
          type: string
          format: date-time
        pT_101:
          type: number
          format: float
        pT_201:
          type: number
          format: float
        pT_202:
          type: number
          format: float
        tT_101:
          type: number
          format: float
        cO2_Flowrate:
          type: number
          format: float
        cO2_Temp:
          type: number
          format: float
        dT_101:
          type: number
          format: float
        iT_101:
          type: number
          format: float
      additionalProperties: false
    ReadingsProcessedResponse:
      type: object
      properties:
        readingsProcessed:
          type: integer
          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: {}