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 32 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 partyId:

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

  2. personalName - Namnet på den person som företagen skall hämtas för.

Hämta företagsengagemang (/engagements)

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

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

Response:

{
    "engagements": [
        {
            "organizationName": "Fritjofs blommor och blad",
            "organizationNumber": "5561234567",
            "organizationId": " 793afd03-3be5-4e14-863f-a61d4859841d"
        },
        {
            "organizationName": "Vanja Jumpers plåt",
            "organizationNumber": "5561234568"
        }
    ]
    "statusDescriptions": {
      "5561234568": "Couldn't fetch guid for organization number"
    },
    "status": "NOK"
}

Förtydligande response-parametrar:

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

    • organizationId: unikt uuid/guid för organisationsnumret.

  • statusDescriptions: Innehåller eventuella fel i samband med hämtandet av bolagsengagemang eller organizationId. T.ex. kan det vara att underliggande system (från bolagsverket) överskred begärd svarstid eller att det inte gick att hämta organizationId. 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.

Testdata

Bolagsverket har lagt upp fiktiva personnummer med olika bolagsengagemang, partyId för dessa personer finns upplagda i testmiljön för CitizenMapping och mappar till följande dokument.

Personnummer

partyId

198104112381

65694a6d-5f5d-4bb6-b256-3b81cb419b60

198101032384

d1eda732-5aec-45e2-a673-4debd42b2f04

198101052382

d4554399-91bb-4258-a7a7-afb9f265dd66

198101012386

740c013c-f979-4ad3-a073-42a6d5255e3a

198101042383

5a4afbf9-8897-42a8-aaf0-de9530849f7c

193403223328

af99121e-4dfc-477c-8b02-daf70603b55f

198104152387

ea4a0b53-fa9a-42a6-89a6-7ab1431a014f

Säkerhetsklassning

Säkerhetsklass 1

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

API-teamet

Ansvarigt team: Team Dynasty

För tekniska frågor: mailto:teamdynasty@sundsvall.se

Länkar

  • No labels