Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 19 Next »

Beskrivning

Hämta bolagengagemang för en privatperson från Bolagsverket.

I steg två skall tjänsten byggas ut mot Bolagsverkets Mina Ombud.

I ett första steg anropar vi Bolagsverkets engagemang-tjänst för att hämta vilka bolagsengagemang en privatperson har.

Då alla anrop mot bolagsverket innebär en kostnad, cachas alla svar från bolagsverket i 30 minuter.

Livscykelstatus

Design

Lösningsbeskrivning

Hantering av personuppgifter

API specifikation

Alla anrop mot bolagsverket har två tvingande parametrar vilket även är tvingande in i detta API förutom personId:

  1. serviceName - Det system som anropet initierades ifrån.

  2. useCaseArea - Indikerar om anropet originerar från ett system eller om det är en person "bakom" anropet.
    Initieras requestet från en person skall “indirect” anges, initieras requestet från ett system (t.ex. batch-körning eller likn.) skall “direct” anges.

Hämta företagsengagemang

Request: /engagements/6a5c3d04-412d-11ec-973a-0242ac130003?personalName=Jane%20Doe&serviceName=Kommunen&useCaseArea=indirect

{
	"personId": "6a5c3d04-412d-11ec-973a-0242ac130003",
	"personalName": "Jane Doe",
	"serviceName": "Kommunen",
	"useCaseArea": "indirect"
}

Response:

{
    "engagements": [
        {
            "organizationName": "Fritjofs blommor och blad",
            "organizationNumber": "5561234567",
            "organizationId": " 793afd03-3be5-4e14-863f-a61d4859841d"
        },
        {
            "organizationName": "Vanja Jumpers plåt",
            "organizationNumber": "5561234568",
            "organizationId": "85da333a-abe7-4088-8224-5714e85c5f7d"
        }
    ]
    "statusDescriptions": null,
    "status": "OK"
}

Förtydligande response-parametrar:

  • engagements: Kan innehålla 0 → n antal engagemang personen har, varje objekt innehåller organisationsnamn och organisationsnummer.

    • WIP: organizationId, kommer vara ett random-genererat UUID tills dess att integrationen mot tjänsten “Organization” blir implementerad.

  • statusDescriptions: Innehåller eventuella fel från bolagsverket, men där vi fått ett svar vi kan hantera. T.ex. kan det vara att underliggande system överskred begärd svarstid. Typen är en “Map<String, String>”.

  • status: Visar om personens alla engagemang kunde hämtas utan fel. Vid eventuella fel sätts denna till “NOK” och det reflekteras även i parametern statusDescriptions genom att varje felbeskrivning läggs till.

  • organizationId: Unik identifirerare för företaget, OBS! Ej implementerad ännu!

Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

<Kontaktuppgifter till utvecklare/teknisk förvaltare>

Länkar

FAQ

<FAQ>

  • No labels