openapi: 3.0.1
info:
  title: API-Agreement
  contact: {}
  version: "0.1"
servers:
  - url: https://api-test.sundsvall.se/agreement/0.1
tags:
- name: Agreement
  description: Agreement resources
paths:
  /agreements/{category}/{facilityId}:
    get:
      tags:
      - Agreement
      summary: Get agreements by category and facility-id
      operationId: getAgreementsByCategoryAndFacilityId
      parameters:
      - name: category
        in: path
        description: Agreement category
        required: true
        schema:
          type: string
          description: Category model
          enum:
          - COMMUNICATION
          - DISTRICT_HEATING
          - DISTRICT_COOLING
          - ELECTRICITY
          - WASTE_MANAGEMENT
          - WATER
        example: ELECTRICITY
      - name: facilityId
        in: path
        description: Id for the facility
        required: true
        schema:
          type: string
        example: 1471222
      responses:
        "404":
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgreementResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/AgreementResponse'
        "500":
          description: Internal Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
security:
  - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth: 
      type: apiKey
      in: header   
      name: apikey  
  schemas:
    Problem:
      type: object
      properties:
        instance:
          type: string
          format: uri
        type:
          type: string
          format: uri
        parameters:
          type: object
          additionalProperties:
            type: object
        status:
          $ref: '#/components/schemas/StatusType'
        title:
          type: string
        detail:
          type: string
    StatusType:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        reasonPhrase:
          type: string
    Agreement:
      type: object
      properties:
        customerId:
          type: string
          description: Customer identifier at the supplier of the agreement
          readOnly: true
          example: "81471222"
        billingId:
          type: string
          description: Billing identifier
          readOnly: true
          example: "111222333"
        agreementId:
          type: string
          description: Agreement identifier
          readOnly: true
          example: 223344-A
        mainAgreement:
          type: boolean
          description: Signal indicating whether the agreement is the main agreement
            or not
          readOnly: true
          example: true
        binding:
          type: boolean
          description: Signal indicating whether the agreement has a binding period
            or not
          readOnly: true
          example: true
        bindingRule:
          type: string
          description: Description of the binding rule in cases where the agreement
            has a binding period
          nullable: true
          readOnly: true
          example: 12 mån bindning
        fromDate:
          type: string
          description: Start date of the agreement
          format: date
          readOnly: true
          example: 2022-01-01
        toDate:
          type: string
          description: End date of the agreement
          format: date
          readOnly: true
          example: 2022-12-31
      description: Agreement model
    AgreementResponse:
      type: object
      properties:
        agreements:
          type: array
          items:
            $ref: '#/components/schemas/Agreement'
      description: Agreement response model
  securitySchemes: {}