Swedish organization numbers generator API

API för att generera svenska organisationsnummer

This is an API for generating Swedish organization numbers for testing purposes.

Detta är en beskrivning av det API för att generera svenska organisationsnummer som finns nedanstående URL. Detta API är skapat för att underlätta testautomatisering mot system som kräver inmatning av organisationsnummer.

Usage

Användning

This API should be very straight forward to use. Just call the API with a GET method.

Detta API bör vara ganska rättframt att använda. Det är bara att anropa API:et med en HTTP GET-metod.

You may modify the behaviour according to the instructions below, but any HTTP GET to the API endpoint will result in returned organization number.

Det går att påverka vad man får tillbaka från API:et, men i enklaste fallet är det bara att skicka en HTTP GET till nedanstående URL för att få tillbaka ett organisationsnummer.

Example:

Exempel:

https://damberg.one/testdata/orgnr/

Swagger/OAS file

Swagger/OAS-fil

The OAS file for the API can be found here.

OAS-filen för detta API återfinns här.

Modifying the behaviour

Modifiera beteendet

HTTP Accept header

The HTTP Access header could be used to choose the data output format for the organization numbers. Any Access value given by the HTTP headers may also be over-ridden with the outputFormat parameter, as may be seen below.

Med HTTP Access-headern kan man påverka utformatet för returnerade organisationsnummer. Värden satta med Access-headern skrivs över av eventuell outputFormat-parameter, vilket går att läsa mer om nedan.

The API handles requests of the following types:

API är förberett för att hantera följande Access-header-värden:

URL parameters

URL-parametrar

Parameter count (default = 1)

The count parameter states how many unique organization numbers to generate. Any value that is not a positive integer of at least one will result in a bad request message.

Parametern count berättar för API:et hur många unika organisationsnummer det ska generera. Allt annat än positiva heltal gör att API:et kastar ett fel.

Example:

Exempel:

https://damberg.one/testdata/orgnr?count=5

Parameter format (default = nnnnnn-nnnn)

The format parameter tells the API in what format it expects the organization numbers to be generated in.

Parametern format beskriver hur varje enskilt organisationsnummer ska vara formaterat.

Valid values are:

Giltiga värden är:

Note that the space character become %20 when URL encoded.

Notera att blanksteg skrivs som %20 när det skrivs i en URL.

Any value outside of this range will generate in a bad request message.

Värden annan än de giltiga genererar ett Bad Request-fel.

Example:

Exempel:

https://damberg.one/testdata/orgnr?count=5&format=nn%20nnnnnn-nnnn

Parameter outputFormat (default = text/plain)

Sometimes you want to override the HTTP Accept header stating expected output format. You may do this with the use of the outputFormat query parameter.

Om man av någon anledning vill använda URL för att beskriva vilket format man vill få sitt resultat-set i kan man använda query-parametern outputFormat.

The API handles requests of the following values for the outputFormat query parameter:

Följande värden kan hanteras för parametern outputFormat av detta API:

Example:

Exempel:

https://damberg.one/testdata/orgnr?count=5&outputFormat=application/json

Parameter orgType (default = [2, 3, 5, 7, 8, 9])

The first digit of a Swedish organization number state the type of organization. If you want specific types of organizations generated, you may change this. Values must be in the 1-9 range to be valid.

Första siffran av ett svenskt organisationsnummer beskriver organisationstypen. Om man vill generera organisationsnummer av vissa typer kan man ange det här. Värden måste vara mellan 1-9 för att vara valida.

The following are the used numbers for different types of Swedish organizations:

Förstasiffror för svenska organisationsnummer, per typ:

Example:

Exempel:

https://damberg.one/testdata/orgnr?count=15&orgType=[1,2]

Version

To retrieve the current version of this API you may use the /version path.

För att hämta aktuell version av detta API kan man använda följande sökväg.

https://damberg.one/testdata/orgnr/version