openapi: 3.0.2
info:
  title: MeasurementData API
  description: "API for fetching measurement-data"
  version: 1.0.0
tags:
  - name: MeasurementData API endpoints
paths:
  /measurmentdata:
    get:
      parameters:
        - in: query
          name: personId
          schema:
            type: string
          description: Person ID
          example: '81471222-5798-11e9-ae24-57fa13b361e1'
          required: true
        - in: query
          name: category
          schema:
            $ref: '#/components/schemas/Category'
          description: Category of data
          example: 'ELECTRICITY'
          required: true
        - in: query
          name: facilityId
          schema:
            type: string
          description: Facility ID
          example: '112233'
          required: true
        - in: query
          name: fromDate
          schema:
            type: string
            format: date
          description: From date
          example: '2022-01-31'
          required: true
        - in: query
          name: toDate
          schema:
            type: string
            format: date
          description: To date
          example: '2022-03-31'
          required: true
        - in: query
          name: resolution
          schema:
            $ref: '#/components/schemas/Resolution'
          required: true
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Data'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceErrorResponse'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceErrorResponse'
components:
  schemas:
    Data:
      type: object
      required:
        - category
        - installationId
        - resolution
      properties:
        category:
          $ref: '#/components/schemas/Category'
        installationId:
          type: string
          example: '1112233'
        resolution:
          $ref: '#/components/schemas/Resolution'
        measurementSeries:
          type: array
          description: Measurement series from different measurement points
          items:
            type: object
            properties:
              unit:
                type: string
                description: Unit for all measurement points
                example: 'm3'
              measurementType:
                type: string
                description: Type of measurement
                example: 'volume'
              metaData:
                type: array
                description: Meta data for a serie
                items:
                  type: object
                  properties:
                    key:
                      type: string
                      example: 'refid'
                    value:
                      type: string
                      example: '123'
              measurementPoints:
                type: array
                items:
                  type: object
                  properties:
                    metaData:
                      type: array
                      description: Meta data for a measurement point
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                            example: 'refid'
                          value:
                            type: string
                            example: '123'
                    value:
                      type: number
                      format: float
                      example: '22.312'
                    date:
                      type: string
                      format: date-time
    ServiceErrorResponse:
      type: object
      properties:
        httpCode:
          format: int32
          type: integer
        message:
          type: string
        technicalDetails:
          $ref: '#/components/schemas/TechnicalDetails'
    TechnicalDetails:
      type: object
      properties:
        rootCode:
          format: int32
          type: integer
        rootCause:
          type: string
        serviceId:
          type: string
        requestId:
          type: string
        details:
          type: array
          items:
            type: string
    Category:
      type: string
      enum:
        - DISTRICT_HEATING
        - ELECTRICITY
        - BROADBAND
        - WASTE
    Resolution:
      type: string
      enum:
        - Hour
        - Day
        - Month
        - Year