Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

API:t visar avtal kopplade till en anläggning.

Livscykelstatus

Under design

Lösningsbeskrivning

<Infoga en Gliffy-bild som visuellt beskriver lösningen>

Hantering av personuppgifter

<Vilka personuppgifter hanteras och varför?>

API specifikation

Expand
titleAPI-nyckel för sandbox-miljö. Klicka på "Authorize" nedan och ange denna nyckel för att testa API:et

eyJ4NXQiOiJOVGRtWmpNNFpEazNOalkwWXpjNU1tWm1PRGd3TVRFM01XWXdOREU1TVdSbFpEZzROemM0WkE9PSIsImtpZCI6ImdhdGV3YXlfY2VydGlmaWNhdGVfYWxpYXMiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhcHBsaWNhdGlvbiI6eyJvd25lciI6ImFkbWluIiwidGllclF1b3RhVHlwZSI6bnVsbCwidGllciI6IjUwUGVyTWluIiwibmFtZSI6IkNvbmZsdWVuY2UiLCJpZCI6NDksInV1aWQiOiI5MTc3ZGYxZC1hMDQwLTQwMTYtOGVjZC05NGM1OGI1NmFjYTYifSwiaXNzIjoiaHR0cHM6XC9cL2FwaS1pbS10ZXN0LnN1bmRzdmFsbC5zZTo0NDNcL29hdXRoMlwvdG9rZW4iLCJ0aWVySW5mbyI6eyJVbmxpbWl0ZWQiOnsidGllclF1b3RhVHlwZSI6InJlcXVlc3RDb3VudCIsImdyYXBoUUxNYXhDb21wbGV4aXR5IjowLCJncmFwaFFMTWF4RGVwdGgiOjAsInN0b3BPblF1b3RhUmVhY2giOnRydWUsInNwaWtlQXJyZXN0TGltaXQiOjAsInNwaWtlQXJyZXN0VW5pdCI6bnVsbH19LCJrZXl0eXBlIjoiU0FOREJPWCIsInBlcm1pdHRlZFJlZmVyZXIiOiIiLCJzdWJzY3JpYmVkQVBJcyI6W3sic3Vic2NyaWJlclRlbmFudERvbWFpbiI6ImNhcmJvbi5zdXBlciIsIm5hbWUiOiJEaXN0dXJiYW5jZXMiLCJjb250ZXh0IjoiXC9kaXN0dXJiYW5jZXNcLzEuMSIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjEuMSIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifSx7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoiRmVlZGJhY2tTZXR0aW5ncyIsImNvbnRleHQiOiJcL2ZlZWRiYWNrc2V0dGluZ3NcLzEuMCIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjEuMCIsInN1YnNjcmlwdGlvblRpZXIiOiJVbmxpbWl0ZWQifV0sInBlcm1pdHRlZElQIjoiIiwiaWF0IjoxNjQzODczMTQzLCJqdGkiOiJlMWY5MDE2Ny0wY2YyLTQzNjEtYTNkMy0wMjI3OTI2ZDdkZjAifQ==.QwZ-BqBVR0ltQmcLYeZBEfkiJMf6jEoduywZhlWcgNs0vbYn3fKb0AgQa1pb9fJU4d3ltS06ZB5InexU6iDDECCkIedggBlxAWGcD5OTRlBygD2Wg9DhtnhOEgUH3J3OyeG5SIo-s1n2J7lsBjbApLlhSUncvspyGlckYn-sqmUx_C5LYBuNKrpJWMlfbCYbtonpvtecT3hJ-Lyl2KRpTX5akMCqGqrKoKXO6Unjr38poZd6bkKx1WZaDZB8nzJT-js3IcuPXvl1e-UFY91XIWVsUmAFCyvkpAb7fzCAusnnz3p8tf9yu_nsdTpYqcqxRmUXYhadSrO3ty6y2KuC4g==

Swagger ui
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:
    ApiKeyAuth: 
      type: {}
 apiKey
      in: header   
      name: apikey

Säkerhetsklassning

Säkerhetsklass <0, 1, 2, 3, 4>

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

https://sundsvall.atlassian.net/wiki/spaces/API

För tekniska frågor: teamunmasked@sundsvall.se

Länkar

FAQ

<FAQ>