Forretningsservices (Webservices)

STAR udstiller services (REST webservices) fra en række systemer og dette område indeholder dokumentation af dem.

Hver service består af:

En oversigtsside med en liste med hvornår de forskellige versioner er ind - og udfaset og links til alle sider, som nævner denne service
En forretningsmæssig side i forhold serviceversioner og release, der bl.a. kan beskriver forretningsindhold i service, oversigt over metoder, forretningsbeskrivelse og -regler til metoder, beskrivelse af WSRM
En side for hver version af servicen (underordnet siden med beskrivelsen) vil for REST service, omfatter siden indholdet af den konkrete JSON fil samt link til Swagger for den pågældende service
En kodeliste service til det pågældende område
Bemærk, at alle DFDG kodelister ligger under sine egen menupunkt f.eks. https://starwiki.atlassian.net/wiki/spaces/FYS/pages/3401712815

Kataloget over service er opbygget ud fra nedenstående struktur, hvor service udstilles i forretningsområder. Forretningsområderne kan ses i nedenstående figur.

Webservice kataloger

Den enkelte kataloger er:

Kontakt SF for at få adgang til de fysiske URL'er på tværs af miljøer.

Services

Gamle versioner af services bliver flyttet til arkiv her Gamle udgaver af Forretningsservices (Webservices)

Swagger

Således aflæses i Swagger om et felt er "nullable":

Man kan se, at et felt er "nulllable" ved at konstatere, at feltet ikke er påkrævet. Påkrævede felter har en stjerne ud for sig i Swagger-UI.

Eksempel

forsikringsgrad i DagpengeService.getDagpenge er "nullable", da der ikke er en stjerne ud for "forsikringsgrad" i modsætning til fx stjernen ud for "udbetalingsmaaned":

CPR-skiftere

DFDG forretningsdomæner

For DFDG forretningsdomæner gælder:

I DFDG forretningsdomæner flyttes data (pegepinden til data) til at være borgers aktuelle cpr,nr, når borger skifter cpr.nr
I DFDG forretningsdomæner kan der alene registreres og opdateres data ved kald med borgers aktuelle cpr.nr
- Serviceaftagere kan hente/læse data i de nye forretningsdomæner uanset om der kaldes med borgers aktuelle eller historisk cpr nr - også hvis borger er død.
- Ved registreringskald til DFDG forretningsdomæner med ikke-aktuelt CPR nummer kaster DFDG fejlkode med oplysning om at borgers aktuelle cpr nr skal anvendes (frem for nuværende brug af fejlkode om at cpr nr ikke findes) - fejlkode 9460 - "Det er ikke tilladt at registrere oplysninger på borgers ikke-aktuelle personnummer"