Gå til hovedindhold
Webservice / Serviceplatformen
DemoService

Formål

Servicens formål er at vise, at man via et simpelt servicekald har teknisk adgang til Serviceplatformen.

Beskrivelse

Servicen indeholder en enkelt operation, callDemoService, hvor man kan afsende og modtage en simple tekststreng.

Servicen er kun tilgængelig i Serviceplatformens eksterne testmiljø.

For uddybning af integrationen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/SP/Demo/1

UUID: d8a062c0-27d1-11e6-b67b-9e71128cae77

EntityId: http://demo.prod-serviceplatformen.dk/service/DemoService/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/SP/Demo/1

UUID: d8a062c0-27d1-11e6-b67b-9e71128cae77

EntityId: http://demo.prod-serviceplatformen.dk/service/DemoService/1

Webservice / Serviceplatformen
DistributionService

Formål

Man kan tilslutte sig Fordelingskomponent som modtagersystem eller afsendersystem eller begge dele. Der udstilles et sæt services til et afsendersystem og et andet sæt services til et modtagersystem. Disse er beskrevet hver for sig nedenfor.

Beskrivelse

Afsendersystem:
Serviceplatformen udstiller en synkron SOAP-service, som et afsendersystem kan kalde med en anmodning om udveksling/overdragelse af et sagsdokument, journalnotat eller formular. Da sagsdokumenter kan være datamæssigt store, overføres selve sagsdokumenter via SFTP, og der refereres til sagsdokumentet i anmodningen.

Serviceplatformen kalder en synkron service udstillet af afsendersystemet umiddelbart efter, modtagersystemet har modtaget anmodning, med en teknisk kvittering, der angiver om modtagersystemet kan teknisk forstå anmodningen (accepteret/afvist).

Såfremt modtagersystemet er Digital Post, vil den tekniske kvittering angive om anmodning kunne videregives til en modtagermyndighed (accept/afvist).

Når anmodningen er forretningsmæssig behandlet i modtagersystemet vil Serviceplatformen kalde afsendersystemet på samme synkrone service, som anvendes til teknisk kvittering, med en forretningsmæssig kvittering med accept eller afvisning af anmodningen.

Der modtages ikke en forretningsmæssig kvittering, hvis modtagersystem er Digital Post.

Modtagersystem:
Serviceplatformen kalder en synkron service på modtagersystemet med en anmodning fra et afsendersystem. Modtagersystemet svarer med en teknisk accept eller afvisning af anmodningen. Er det et sagsdokument, som der modtages en anmodning på, undersøger modtagersystem om dokumentet kan hentes via SFTP, før der svares på servicekaldet. Dokumentet hentes efterfølgende.

Når modtagersystemet har forretningsmæssigt behandlet en anmodning, kan modtagersystemet via en service udstillet af Serviceplatformen svare med en kvittering, som indeholder en forretningsmæssig accept eller afvisning af anmodningen.

Digital Post:
Sendes en anmodning til Digital Post, vil Serviceplatformen kalde Digital Post og alene modtage en transportkvittering som svar. Såfremt modtageren ønsker at afvise anmodningen, skal dette ske via mail-korrespondance.

Servicens datagrundlag:
Fordelingskomponenten selv indeholder kun data, der gør det muligt at fordele anmodning. Disse data er følgende:

- Myndighed
- KLE emne
- KLE emne facet
- SystemUUID

De tre første parametre angives i anmodning, og kan herefter opløses til SystemUUID.

Servicen er udstillet med følgende sikkerhedsmodeller:
- AuthorityContext
- SAML-token

Udveksling mellem UDK og kommunerne vil være dækket af en fælles databehandleraftale for de fælleskommunale systemer. Er der tale om systemer, der ikke er fælleskommunale, skal det undersøges, om udvekslingen er dækket af en databehandleraftale. Afsender og modtager skal også verificere om leverandøren af modtager- og afsendersystem har den fornødne instruks til databehandling.

Ønsker afsender og modtager at udveksle formularer, skal afsender og modtager selv indgå aftale om dette, samt aftale og definerer formularen.

Afsender
Digital Post skal være konfigureret til at anvende KOMBIT som afsendersystem, og der skal være opsat et materialeID, som kan anvendes af Fordelingskomponenten.

Når serviceaftale oprettes, skal Digital Post SysID og materialeID angives, samt en e-mail, hvor en afsender kan kontaktes i forbindelse med modtagelse af en anmodning gennem Digital Post.

Tilslutning til simpel SFTP på Serviceplatformen.

Modtager
Konfiguration af KLE-emne, KLE-emnefacet i relation til myndighed og system, så anmodninger kan rutes korrekt til et modtagersystem eller Digital Post.

Tilslutning til simpel SFTP på Serviceplatformen.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/SP/Distribution/3

UUID: 74d3c5f5-1b3c-4c6d-8366-1241f055d332

EntityId: http://sp.serviceplatformen.dk/service/fordeling/3

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/SP/Distribution/3

UUID: 74d3c5f5-1b3c-4c6d-8366-1241f055d332

EntityId: http://sp.serviceplatformen.dk/service/fordeling/3

Webservice / Fælleskommunalt Sags- og Dokumentindeks
DokumentIndeksService

Formål

Servicen anvendes til fysisk sletning af dele af forretningsobjektet Dokument i Sags- og Dokumentindeks.

Beskrivelse

Servicen indeholder to operationer:

- Kassér – anvendes til fysisk sletning af dele af forretningsobjektet Dokument, fx sletning af en relation.

- Fjern – anvendes til fysisk sletning af et eller flere forretningsobjekter af typen Dokument. Dokumenter kan også fjernes i sammenhæng med sletning af en eller flere sager – se servicen SagDokumentIndeksService.

Servicen er udstillet med følgende sikkerhedsmodel:

- OIO IDWS

Eksternt testmiljø

Endpoint: https://sagsogdokumentindeks.eksterntest-stoettesystemerne.dk/dokumentindeks/6

Produktionsmiljø

Endpoint: https://sagsogdokumentindeks.stoettesystemerne.dk/dokumentindeks/6

Webservice / Digitalisering - Udsatte Børn og Unge 3.0
DUBUSagHent

Formål

Med webservicen kan et anvendersystem tilgå sager og dokumenter i løsningen DUBU, som en sagsbehandler har bevilget adgang til.

Der returneres kun data om sager, som anvendersystemet (datarekvirenten) har fået tildelt adgang til.

Beskrivelse

Servicen indeholder tre operationer:

- SagListeHent (returnerer en liste over UUID og partinformation (CPR mv.) for de sager datarekvirent har adgang til.)
- SagHent (returnerer detaljer om en specifik sag, herunder en liste med dokument-UUID og tilhørende metadata, der er bevilget adgang til på sagen. Læsningen er baseret på sagens UUID.)
- DokumentFilHent (returnerer en fil, der indeholder selve dokumentet (fx PDF). Læsningen baseres på sagens UUID og dokumentets UUID.)

Webservice / Serviceplatformen
DUPLAÅrsopgørelseHent

Formål

Formålet med servicen er at levere udvalgte data for en liste af årsopgørelser fra et eller flere indkomstår om én eller flere personer.

Serviceanvender skal ved hjælp af en aftale i DUPLA Aftalemodul specificere de nødvendige felter i forhold til det konkrete anvendelsesformål. Servicen returnerer udelukkende de felter til serviceanvender, som er specificeret i denne aftale.

Beskrivelse

Servicen kræver en liste af PersonCPRNummer og en liste af IndkomstÅr, og returnerer de i dataudvekslingsaftalen specificerede data fra den gældende årsopgørelse for de udvalgte IndkomstÅr for de udvalgte PersonCPRNummer. Med udgangspunkt i DIGST Fælles Retningslinjer for webservices R19, R21 og R22 er der yderligere søgeparametre, som kan benyttes.

Der kan defineres en periode ved at bruge UdstillingRegistreringFra og/eller UdstillingRegistreringTil, som vil resultere i, at der kun leveres årsopgørelser, der i den angivne periode, er registreret som udstillet på GUL og dermed gjort tilgængelig for serviceanvenderne. Dette kan fx bruges til at hente årsopgørelser, der er blevet tilgængelige siden der sidst blev forespurgt på løsningen, ved at udfylde UdstillingRegistreringFra med det tidspunkt, hvor der sidst blev forespurgt.

Som udgangspunkt leveres kun aktuelle årsopgørelser, men ved brug af ÅrsopgørelseGyldigFra og/eller ÅrsopgørelseGyldigTil kan der defineres en periode, som vil resultere i at servicen leverer alle årsopgørelser, som har en gyldighedsperiode, der helt eller delvist overlapper med denne periode.

En given årsopgørelse med tilhørende ÅrsopgørelseOpgørelseNummer ændres ikke, med den undtagelse, at der tilføjes en ÅrsopgørelseGyldigTil, hvis der dannes en ny årsopgørelse for det aktuelle IndkomstÅr, som gør, at denne årsopgørelse ikke længere er den gældende. Det er altså muligt at se, om en årsopgørelse er den gældende årsopgørelse for den aktuelle person i det specifikke år, ved at se, om ÅrsopgørelseGyldigTil er sat. Vær opmærksom på, at en ny årsopgørelse ikke nødvendigvis resulterer i synlige ændringer, da aftalen specificeret i aftalemodulet ikke nødvendigvis omfatter de felter, som er påvirkede.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLA_1

UUID: a38f0fd8-2a99-40db-b194-56dddf750afb

EntityId: http://entityid.kombit.dk/service/duplaaarsopgoerelsehent/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLA_1

UUID: a38f0fd8-2a99-40db-b194-56dddf750afb

EntityId: http://entityid.kombit.dk/service/duplaaarsopgoerelsehent/1

Webservice / Serviceplatformen
DUPLAForskudsopgørelser

Formål

Formålet med servicen er at levere udvalgte data for en liste af forskudsopgørelser fra et indkomstår for én til flere personer.

Beskrivelse

Serviceanvender skal ved hjælp af en aftale i DUPLA Aftalemodul specificere de nødvendige felter i forhold til det konkrete anvendelsesformål. Servicen returnerer udelukkende de felter til serviceanvender, som er specificeret i aftalen.

Strukturen af Forskudsopgørelsen ændres hvert år i takt med at skattelovgivningen ændrer sig. Der vil derfor hvert år være ændringer i servicens indhold, der som regel vil bestå af tilføjelse af data.

Som anvender af servicen skal man derfor være indstillet på, at servicen er genstand for et ”årsrul”, hvor der kan blive tilføjet flere felter til servicesvaret. Alle data er dog valgfri i den forstand, at de til- og fravælges i den profil, der opsættes for en anvender i samarbejde med Udviklings- og forenklingsstyrelsen (UFST), og man vil derfor kun modtage felter, der er i overensstemmelse med den opsatte profil, og ikke nye uventede felter. I den forstand er servicen bagudkompatibel.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLAForskudsopgorelser_1

UUID: c33b49c3-1e14-4a3e-bace-2724aadf18b1

EntityId: http://entityid.kombit.dk/service/sp/duplaforskudsopgoerelser/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLAForskudsopgorelser_1

UUID: c33b49c3-1e14-4a3e-bace-2724aadf18b1

EntityId: http://entityid.kombit.dk/service/sp/duplaforskudsopgoerelser/1

Webservice / Serviceplatformen
DUPLAKontroloplysninger

Formål

Formålet med servicen er at levere udvalgte data for en liste af kontroloplysninger fra et eller flere indkomstår om én eller flere personer eller virksomheder.

Beskrivelse

Serviceanvender skal ved hjælp af en aftale i DUPLA Aftalemodul specificere de nødvendige felter i forhold til det konkrete anvendelsesformål. Servicen returnerer udelukkende de felter til serviceanvender, som er specificeret i aftalen.

Strukturen af data ændres hvert år i takt med at skattelovgivningen ændrer sig. Der vil derfor hvert år være ændringer i servicens indhold, der som regel vil bestå af tilføjelse af data.

Som anvender af servicen skal man derfor være indstillet på, at servicen er genstand for et ”årsrul”, hvor der kan blive tilføjet flere felter til servicesvaret.
Alle data er dog valgfri i den forstand, at de til- og fravælges i den profil, der opsættes for en anvender i samarbejde med Udviklings- og forenklingsstyrelsen (UFST), og man vil derfor kun modtage felter der er i overensstemmelse med den opsatte profil, og ikke nye uventede felter. I den forstand er servicen bagudkompatibel.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLAKontroloplysninger_1

UUID: 794b1262-fbb1-4dbd-860a-aff40e229d85

EntityId: http://entityid.kombit.dk/service/sp/duplakontroloplysninger/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLAKontroloplysninger_1

UUID: 794b1262-fbb1-4dbd-860a-aff40e229d85

EntityId: http://entityid.kombit.dk/service/sp/duplakontroloplysninger/1

Webservice / Serviceplatformen
DUPLALogbog

Formål

Formålet med servicen at oprette, opdatere, slette og hente data for en arbejdstager i den digitale logbog.

Beskrivelse

Følgende dataområder understøttes af servicen:

- Arbejdstagere:
Paths, der gør det muligt for virksomheder at oprette, opdatere, slette og hente data for en arbejdstager i den digitale logbog. Arbejdsgiveren skal dagligt foretage registreringer over beskæftigede, både lønnet og ulønnet, i virksomheden med oplysninger om navn, CPR.nr., arbejdstider og løn.

- Arbejdstidsangivelse:
Paths, der gør det muligt for virksomheder at oprette, rette, slette og hente data for en arbejdsdagsangivelse i den digitale logbog. Arbejdsgiveren skal dagligt foretage registreringer over beskæftigede, både lønnet og ulønnet, i virksomheden med oplysninger om navn, CPR.nr., arbejdstider og løn.

- Dagsoversigt:
Path, der gør det muligt for virksomheder at hente dagsoversigt over arbejdstidsangivelser (grupperet på arbejdstager) og/eller nuldagsangivelse(r).

- GDPRAdministration:
Paths, der gør det muligt at fremsøge, skjule og slette data vedrørende en arbejdstager, som er oprettet i en virksomheds digitale medarbejderlogbøger. En myndighed kan pålægge en virksomhed en logbogspligt, som indebærer, at arbejdsgiveren dagligt skal foretage registreringer over beskæftigede, både lønnet og ulønnet, i virksomheden med oplysninger om navn, CPR.nr., arbejdstider og løn. Servicen muliggør, at myndigheden kan pålægge denne logbogspligt og ydermere opdatere slette og hente logbogspligter.

- Logbogskontrol:
Paths, der gør det muligt for en myndighed at oprette og hente data for kontrolbesøg af de virksomheder, som er pålagt logbogspligten. Arbejdsgiveren skal dagligt foretage registreringer over beskæftigede, både lønnet og ulønnet, i virksomheden med oplysninger om navn, CPR.nr., arbejdstider og løn.

- Logbogspligter:
Paths, der gør det muligt for en myndighed at oprette, opdatere, slette og hente data for en logbogspligt. En myndighed kan pålægge en virksomhed en logbogspligt, som indebærer at arbejdsgiveren dagligt skal foretage registreringer over beskæftigede, både lønnet og ulønnet, i virksomheden med oplysninger om navn, CPR.nr., arbejdstider og løn. Servicen muliggør, at myndigheden kan pålægge denne logbogspligt og ydermere opdatere slette og hente logbogspligter.

- Nuldagsangivelser:
Paths, der gør det muligt for en virksomhed at oprette og slette en nuldagsangivelse i den digtale logbog.

- ValiderCPRNummer:
Path, der gør det muligt at validere CPRnummer i CPR-registret, når en arbejdstager bliver oprettet i Digital Logbog.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLALogbog_1

UUID: bd8f51f3-2c67-4220-9511-7967f9c94e5a

EntityId: http://entityid.kombit.dk/service/duplalogbog/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLALogbog_1

UUID: bd8f51f3-2c67-4220-9511-7967f9c94e5a

EntityId: http://entityid.kombit.dk/service/duplalogbog/1

Webservice / Serviceplatformen
DUPLAPensionsrettigheder

Formål

Formålet med API'et er at udstille oplysninger vedrørende pensionsrettigheder fra Integrationsplatformen DUPLA.

Beskrivelse

Anvender kan ved hjælp af en aftale i DUPLA Aftalemodul specificere de nødvendige felter i forhold til det konkrete anvendelsesformål. API'et returnerer udelukkende de felter til serviceanvender, som er specificeret i aftalen.

Der udstilles det komplette datasæt fra kildesystemet. Dette omfatter dog kun forretningsdata og ikke tekniske data. Servicen tilbyder også adgang til historiske data, men hvis dette ikke specifikt tilvælges, leveres kun nyeste angivelse.

Korrekthed:
- Servicen udstiller kun validerede data.

Aktualitet:
- Data hentes direkte i kildesystemet, hvilket betyder, at der er direkte adgang til de nyeste data.

Strukturen af data ændres hvert år i takt med at skattelovgivningen ændrer sig. Der vil derfor hvert år være ændringer i servicens indhold, der som regel vil bestå af tilføjelse af data.

Som anvender af servicen skal man derfor være indstillet på, at servicen er genstand for et ”årsrul”, hvor der kan blive tilføjet flere felter til servicesvaret. Alle data er dog valgfri i den forstand, at de til- og fravælges i den profil, der opsættes for en anvender i samarbejde med Udviklings- og forenklingsstyrelsen (UFST), og man vil derfor kun modtage felter, der er i overensstemmelse med den opsatte profil, og altså nye uventede felter. I den forstand er servicen bagudkompatibel.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLAPensionsrettigheder_1

UUID: 393f36da-9b8e-4557-8fad-e5febaa74858

EntityId: http://entityid.kombit.dk/service/sp/duplapensionsrettigheder/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLAPensionsrettigheder_1

UUID: 393f36da-9b8e-4557-8fad-e5febaa74858

EntityId: http://entityid.kombit.dk/service/sp/duplapensionsrettigheder/1

Webservice / Serviceplatformen
DUPLASelvstændigVirksomhedOplysninger

Formål

Formålet med API'et er at udstille oplysninger vedrørende selvstændige virksomheder fra Integrationsplatformen DUPLA.

Beskrivelse

Anvender kan ved hjælp af en aftale i DUPLA Aftalemodul specificere de nødvendige felter i forhold til det konkrete anvendelsesformål. API'et returnerer udelukkende de felter til serviceanvender, som er specificeret i aftalen.

Strukturen af data ændres hvert år i takt med at skattelovgivningen ændrer sig. Der vil derfor hvert år være ændringer i servicens indhold, der som regel vil bestå af tilføjelse af data.

Som anvender af servicen skal man skal derfor være indstillet på, at servicen er genstand for et ”årsrul”, hvor der kan blive tilføjet flere felter til servicesvaret. Alle data er dog valgfri i den forstand, at de til- og fravælges i den profil, der opsættes for en anvender i samarbejde med Udviklings- og forenklingsstyrelsen (UFST), og man vil derfor kun modtage felter, der er i overensstemmelse med den opsatte profil, og ikke nye uventede felter. I den forstand er servicen bagudkompatibel.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/DUPLASelvstændigVirksomhedOplysninger_1

UUID: 4c4c598c-b7a9-47c7-b87d-f28adb74db6b

EntityId: http://entityid.kombit.dk/service/sp/duplaselvstaendigvirksomhedoplysninger/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/DUPLASelvstændigVirksomhedOplysninger_1

UUID: 4c4c598c-b7a9-47c7-b87d-f28adb74db6b

EntityId: http://entityid.kombit.dk/service/sp/duplaselvstaendigvirksomhedoplysninger/1