swagger: '2.0'
info:
  description: Bolagsverkets API for electronic annual report events
  version: '1.0'
  title: API for electronic annual report events
  termsOfService: http://diar.bolagsverket.se/api/terms/
  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-arsredovisningshandelser/v1.0
schemes: [https]
tags:
- {name: handelser, description: Services that retrieve information about annual report events}
paths:
  /handelser:
    post:
      tags: [handelser]
      summary: Retrieve annual report events for public companies.
      description: The service retrieves annual report events for public companies.
      operationId: handelser
      consumes: [application/json;charset=utf-8]
      produces: [application/json;charset=utf-8]
      parameters:
      - name: anropsobjekt
        description: URL and organisation number
        in: body
        required: true
        schema: {$ref: '#/definitions/HandelserAnrop'}
      responses:
        '200':
          description: OK
          schema: {$ref: '#/definitions/HandelserOK'}
        '400':
          description: Bad request
          schema: {$ref: '#/definitions/Fel'}
        '403':
          description: Unauthorized user of service
          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]
  HandelserAnrop:
    type: object
    description: Request object for the annual report event service
    properties:
      url: {description: URL for subscription to annual report events., type: string}
      orgnr:
        type: array
        items: {description: Organisation numbers for which events are to be retrieved.,
          type: string, pattern: '[0-9]{10}'}
      fromtidpunkt: {description: Start timestamp for annual report events., type: string,
        format: date-time}
      tomtidpunkt: {description: End timestamp for annual report events., type: string,
        format: date-time}
    required: [url]
  HandelserOK:
    type: object
    description: Response object for the annual report event service.
    properties:
      meddelanden:
        type: array
        items: {$ref: '#/definitions/Handelse'}
  Handelse:
    type: object
    description: An annual report event.
    properties:
      typ: {type: string, maxLength: 20, description: Type of event.}
      id: {type: string, maxLength: 40, description: 'Event identity, ie. organisation
          number for the public company.'}
      nr: {type: integer, format: int64, description: Sequence number of the event.}
      tid: {type: string, format: date-time, description: Timestamp of the event.}
      data: {$ref: '#/definitions/Arsredovisningshandelse'}
    required: [typ, id, nr, tid, data]
  Arsredovisningshandelse:
    type: object
    description: Annual report event regarding an electronically filed annual report.
    properties:
      status:
        type: string
        description: Current status of the annual report.
        enum: [arsred_inkommen, arsred_registrerad, arsred_avslutad_ej_registrerad]
externalDocs: {description: Information aboud electronic annual reports, url: 'http://diar.bolagsverket.se'}