swagger: '2.0' info: description: Bolagsverkets API for creating checksum for iXBRL file version: '1.0' title: API for creating checksum for iXBRL file contact: {name: The Swedish Companies Registration Office Group for electronic annual reports, email: emsdiar@bolagsverket.se} license: {name: Public document according to the Swedish Press Act, 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: Services that supply information} paths: /skapa-kontrollsumma: post: tags: [kontrollsumma] summary: Create checksum for iXBRL file description: The service provides checksum for an iXBRL file. operationId: skapa-kontrollsumma consumes: [application/json;charset=utf-8] produces: [application/json;charset=utf-8] parameters: - name: anropsobjekt description: For example. annual report in iXBRL format. The file must have the charset UTF-8. in: body required: true schema: {$ref: '#/definitions/SkapaKontrollsummaAnrop'} responses: '200': description: OK schema: {$ref: '#/definitions/SkapaKontrollsummaOK'} '400': description: Bad request schema: {$ref: '#/definitions/Fel'} '403': description: Unauthorized user of service schema: {$ref: '#/definitions/Fel'} '404': description: Anropsobjekt saknas schema: {$ref: '#/definitions/Fel'} '500': description: Unspecified technical problem schema: {$ref: '#/definitions/Fel'} '503': description: The service is temporarily unavailable schema: {$ref: '#/definitions/Fel'} '504': description: Timeout schema: {$ref: '#/definitions/Fel'} definitions: Upplysning: type: object description: Contains further details on errors etc. properties: kod: {type: integer, format: int32, description: Code that describes the kind of information. Described in a separate document.} text: {type: string, description: Text that leaves further information.} typ: type: string description: Classification of the information - info, warning or error. enum: [info, warn, error] required: [kod, text, typ] Fel: type: object description: Provides detailed error information. properties: kod: {type: integer, format: int32, description: Code that describes the error. Described in a separate document.} text: {type: string, description: Text that leaves further information about the error.} detaljinformation: type: array description: Detailed information about the error items: {$ref: '#/definitions/Upplysning'} required: [kod, text] SkapaKontrollsummaAnrop: type: object description: Call object to create checksum. properties: fil: {type: string, format: byte, description: For example. annual report in iXBRL format. The file must have the charset UTF-8.} required: [fil] SkapaKontrollsummaOK: type: object properties: kontrollsumma: {type: string, format: byte, description: checksum for selected parts of the iXBRL file} algoritm: {type: string, description: algorithm for calculating checksum} required: [kontrollsumma, algoritm] externalDocs: {description: Information aboud electronic annual reports, url: 'http://bolagsverket.se/om/oss/utveckling-av-digitala-tjanster/digital-ingivning'}