swagger: '2.0'
info:
  description: Bolagsverkets API för att skapa kontrollsumma för iXBRL-fil
  version: '1.0'
  title: API för att skapa kontrollsumma för iXBRL-fil
  contact:
    name: Bolagsverkets grupp för digitala årsredovisningar
    email: emsdiar@bolagsverket.se
  license:
    name: Offentlig handling enligt Tryckfrihetsförordningen 2 Kap 3 §
    url: 'http://www.notisum.se/rnp/sls/lag/19490105.htm#K2P3'
host: api.bolagsverket.se
basePath: /hamta-arsredovisningsinformation/v1.0
schemes:
  - https
tags:
  - name: information
    description: Tjänster som lämnar information
paths:
  '/skapa-kontrollsumma':
    post:
      tags:
        - kontrollsumma
      summary: Skapa kontrollsumma för iXBRL-fil
      description: >-
        Tjänsten levererar kontrollsumma för en iXBRL-fil.
      operationId: skapa-kontrollsumma
      consumes:
        - "application/json;charset=utf-8"
      produces:
        - "application/json;charset=utf-8"
      parameters:
        - name: anropsobjekt
          description: T.ex. årsredovisning i iXBRL-format. Filen ska ha charset UTF-8.
          in: body
          required: true
          schema:
            $ref: '#/definitions/SkapaKontrollsummaAnrop'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SkapaKontrollsummaOK'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'          
        '404':
          description: Anropsobjekt saknas
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'

definitions:
  Upplysning:
    type: object
    description: Innehåller mer detaljerad information om ett fel el dyl.
    properties:
      kod:
        type: integer
        format: int32
        description: Kod som beskriver upplysningen. Beskrivs i separat dokument.
      text:
        type: string
        description: Förklarande text till upplysningen.
      typ:
        type: string
        description: Upplysningens karaktär - information, varning eller fel.
        enum:
          - info
          - warn
          - error
    required: ["kod", "text", "typ"]
  Fel:
    type: object
    description: Beskriver fel.
    properties:
      kod:
        type: integer
        format: int32
        description: Kod som beskriver felet. Beskrivs i separat dokument.
      text:
        type: string
        description: Förklarande text till felet.
      detaljinformation:
        type: array
        description: Detaljupplysningar om felet
        items:
          $ref: '#/definitions/Upplysning'
    required: ["kod", "text"]
  SkapaKontrollsummaAnrop:
    type: object
    description: Anropsobjekt för att skapa kontrollsumma.
    properties:
      fil:
        type: string
        format: byte
        description: T.ex. årsredovisning i iXBRL-format. Filen ska ha charset UTF-8.
    required: ["fil"]
  SkapaKontrollsummaOK:
    type: object
    properties:
      kontrollsumma:
        type: string
        format: byte
        description: kontrollsumma för utvalda delar av iXBRL-filen
      algoritm:
        type: string
        description: algoritm för uträkning av kontrollsumma
    required: ["kontrollsumma", "algoritm"]
    
externalDocs:
  description: Information om digitala årsredovisningar
  url: 'http://bolagsverket.se/om/oss/utveckling-av-digitala-tjanster/digital-ingivning'