Komposit.CodeListsService (2024-4)
- Knud de Place (STAR)
Forretningsbeskrivelse
Denne service benyttes til at hente alle de kodelister der benyttes af services i Det Fælles Datagrundlag (DFDG) uanset hvilke forretningsdomæne der er dataejer af den pågældende kodeliste.
En serviceaftager kan enten implementere denne service, hvis de implementerer de udstillede services i Det Fælles Datagrundlag eller alternativt implementerer kodeliste fra de enkelte forretningsdomæners egne kodelisteservice.
Det er aftagerapplikationens opgave at udstille kodelisterne til brugerne på en sigende måde. Det kan således ikke anbefales at benytte beskrivelserne direkte i aftagerapplikationerne i forbindelse med indberetninger, da beskrivelserne kan indeholde referencer til felter i webservicebeskeden, som ikke modsvarer en semantik eller begrebsmodel, der giver mening for brugeren af den enkelte applikation.
Servicen skal kaldes én gang (et begrænset antal gange) i døgnet således serviceaftagere har en form for caching af kodelistedata. Det er ikke tilladt for serviceaftagere at kalde disse services i forbindelse med hver enkelt servicekald, da dette vil generere en meget stor mængde unødig trafik mod DFDG.
Som hovedprincip må kun registreres kodeværdier der er aktuelle, det vil sige, hvor slutdatoen er senere end dags dato.
Hvis slutdatoen er overskredet skal værdien kun bruges for læslighed af gamle værdier og eventuelle opdateringer af forhold der allerede eksisterer data og hvorom det gælder at de udgået kodeliste var aktiv i periode hvor de ønskes anvendt. De konkrete situation hvor udgået kodelisteværdie kan anvendes til opdatering, vil fremgå af forretningsreglerne på de pågældende metode hvor dette er lovligt.
Link til snitfladebeskrivelser
Link til forretningsbeskrivelser
Found 5 search result(s) for codelistservice.
Metoder
GetCodeList (GET /v1/CodeLists/{name})
Henter en specifik kodelistes værdisæt.
GetCodeLists (GET /v1/CodeLists)
Henter alle kodelisters værdisæt ejet af komposit.
GetErrorCodeList (GET /v1/CodeLists/ErrorCodeList)
Henter alle Fejlkoder ejet af komposit.
GetAllCodeLists (GET /v1/CodeLists/all)
Henter alle kodelisters værdisæt på tværs af siloer.
GetAllErrorCodeList (GET /v1/CodeLists/ErrorCodeList/all)
Henter alle Fejlkoder på tværs af siloer.