swagger: '2.0' info: description: Bolagsverkets API för att hantera prenumerationer på årsredovisningshändelser version: '1.1' title: API för hantering av prenumerationer på årsredovisningshändelser 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: /hantera-arsredovisningsprenumerationer/v1.1 schemes: - https tags: - name: prenumeration description: Tjänster för att prenumerera på årsredovisningshändelser paths: '/handelseprenumeration': post: tags: - prenumeration summary: Prenumerera på årsredovisninghändelser description: >- Tjänsten tar emot en förfrågan om prenumeration på organisationsnummer till önskade urler samt kontrollerar att organisationsnumren är giltiga. operationId: prenumerera consumes: - "application/json;charset=utf-8" produces: - "application/json;charset=utf-8" parameters: - name: anropsobjekt description: URL och organisationsnummer in: body required: true schema: $ref: '#/definitions/PrenumerationAnrop' responses: '202': description: Accepted '400': description: Felaktig request schema: $ref: '#/definitions/Fel' '403': description: Obehörig användare av tjänsten 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' get: tags: - prenumeration summary: Hämta prenumerationer description: >- Tjänsten hämtar prenumerationer som finns för en viss url, orgnr, fr.o.m. datum, t.o.m. datum. eller kombinationer av dessa. Minst ett (1) sökvillkor måste anges. operationId: hamta-prenumerationer consumes: - "application/json;charset=utf-8" produces: - "application/json;charset=utf-8" parameters: - in: query name: url type: string description: URL required: false - in: query name: orgnr type: string pattern: '[0-9]{10}' description: Organisationsnummer för prenumeration. required: false - in: query name: from type: string format: date description: Från och med datum när prenumerationen registrerades required: false - in: query name: tom type: string format: date description: Till och med datum när prenumerationen registrerades required: false responses: '200': description: OK schema: $ref: '#/definitions/HamtaPrenumerationerOK' '400': description: Felaktig request schema: $ref: '#/definitions/Fel' '403': description: Obehörig användare av tjänsten 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' delete: tags: - prenumeration summary: Avsluta prenumeration på årsredovisninghändelser description: >- Tjänsten tar emot en förfrågan om att avsluta prenumeration för önskad url och organisationsnummer. operationId: avsluta-prenumeration consumes: - "application/json;charset=utf-8" produces: - "application/json;charset=utf-8" parameters: - name: anropsobjekt description: URL och organisationsnummer in: body required: true schema: $ref: '#/definitions/AvslutaPrenumerationAnrop' responses: '202': description: Accepted '400': description: Felaktig request schema: $ref: '#/definitions/Fel' '403': description: Obehörig användare av tjänsten 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"] PrenumerationAnrop: type: object description: Anropsobjekt för prenumerationer properties: prenumerationer: type: array items: $ref: '#/definitions/Prenumeration' required: ["prenumerationer"] Prenumeration: type: object description: Uppgifter för prenumeration. properties: url: description: URL för årsredovisningshändelser. type: string orgnr: description: Organisationsnummer för prenumeration. type: string pattern: '[0-9]{10}' authKey: description: >- Nyckel för prenumerationen (valfri). Dennna nyckel skickas med vid utskick av händelser och kan användas för att säkerställa att det är bolagsverket som skickat händelsen. type: string maxLength: 40 skickaTestmeddelande: description: >- Om 'true' skickas ett testmeddelande direkt när prenumerationen skapats. Detta testmeddelande har nummer -1. type: boolean default: false required: ["url", "orgnr"] HamtaPrenumerationerOK: type: object description: Resultat för hämtning av prenumerationer på en URL. properties: prenumerationer: type: array items: $ref: '#/definitions/LagradPrenumeration' required: ["prenumerationer"] LagradPrenumeration: type: object description: Uppgifter om befintlig prenumeration på efterfrågad URL. properties: url: description: URL för årsredovisningshändelser. type: string orgnr: description: Organisationsnummer för prenumeration. type: string pattern: '[0-9]{10}' registrerad: description: Tidpunkt när prenumerationen registrerades. type: string format: date-time avslutas: description: Datum efter vilket prenumerationen tas bort per automatik. type: string format: date required: ["url", "orgnr","registrerad","avslutas"] AvslutaPrenumerationAnrop: type: object description: Anropsobjekt för prenumerationer. properties: url: description: URL för årsredovisningshändelser. type: string orgnr: description: >- Organisationsnummer för prenumeration. Om det utelämnas tas alla prenumerationer på angiven url bort. type: string pattern: '[0-9]{10}' required: ["url"] externalDocs: description: Information om digitala årsredovisningar url: 'http://bolagsverket.se/om/oss/utveckling-av-digitala-tjanster/digital-ingivning'