Gå til hovedindhold
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
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.

Beskedservice / Fælleskommunal Beskedfordeler
eSkattekortBeskedHent

Formål

Med beskedservicen kan gyldige skattekort for en borger hentes af myndighedens fagsystem via Beskedfordeleren. I perioden nær et årsskifte modtages skattekort for både indeværende og kommende år i separate beskeder.

Ønsker myndigheden at modtage skattekort som push-beskeder, kan servicen eSkattekortBeskedModtag anvendes.

Beskrivelse

Servicen videresender beskeder til myndigheders fagsystemer med skattekort i XML-format fra SKATs eIndkomst. Endpoint benyttes af fagsystemerne i forbindelse med modtagelse af skattekort.

Beskeden indeholder:
- CPR-nummer for borgeren
- SE-nummer for indkomstforholdet (udbetalende virksomhed/myndighed)
- Type af skattekort
- Trækprocent uden lønindeholdelse
- Trækprocent med lønindeholdelse (ved gældsinddrivelse via SKAT)
- Fradrag (dag/uge/14 dage/måned)

Beskedservice / Fælleskommunal Beskedfordeler
eSkattekortBeskedModtag

Formål

Med beskedservicen pushes gyldige skattekort for en borger til myndighedens fagsystem via Beskedfordeleren. I perioden nær et årsskifte modtages skattekort for både indeværende og kommende år i separate beskeder.

Ønsker myndigheden at modtage skattekort som pull-beskeder, kan servicen eSkattekortBeskedHent anvendes.

Nyt i denne version

Første majorversion

Beskrivelse

Servicen videresender beskeder til myndigheders fagsystemer med skattekort i XML-format fra SKATs løsning eIndkomst. Endpoint benyttes af fagsystemerne i forbindelse med modtagelse af skattekort.

Beskeden indeholder:
- CPR-nummer for borgeren
- SE-nummer for indkomstforholdet (udbetalende virksomhed/myndighed)
- Type af skattekort
- Trækprocent uden lønindeholdelse
- Trækprocent med lønindeholdelse (ved gældsinddrivelse via SKAT)
- Fradrag (dag/uge/14 dage/måned)

Eksternt testmiljø

Endpoint: amqp://beskedfordeler.eksterntest-stoettesystemerne.dk:5671

Produktionsmiljø

Endpoint: amqp://beskedfordeler.stoettesystemerne.dk:5671

Webservice / Serviceplatformen
eSkattekortService

Formål

Servicen er en synkron webservice, hvormed et anvendersystem kan hente oplysninger om skattekort fra SKATs løsning eIndkomst.

Beskrivelse

Et anvendersystem forespørger på oplysninger om skattekort ved kald af service på Serviceplatformen, som gennemstiller kaldet fra fagsystemet til SKATs løsning eIndkomst. eIndkomst svarer synkront på kaldet til Serviceplatformen, som gennemstiller kaldet fra eIndkomst til fagsystemet.

Anvendersystemet identificerer sig med det SE-nr. som ansættelsesforholdet er oprettet under. Herudover medgives personnummer for borgeren, samt periode man ønsker at hente et skattekort for. Det er også muligt at hente en liste med skattekort fra en dato og frem til det aktuelle gyldige skattekort.

Output er:
- Skattekort eller liste af skattekort. Skattekort kan være hoved- eller bi-kort.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/SKAT/eSkattekort/2

UUID: 47d79e13-02cf-42f3-ad7e-2654b2a70427

EntityId: http://skat.serviceplatformen.dk/service/eskattekort/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/SKAT/eSkattekort/2

UUID: 47d79e13-02cf-42f3-ad7e-2654b2a70427

EntityId: http://skat.serviceplatformen.dk/service/eskattekort/2

Webservice / Fælleskommunalt Klassifikationssystem
FacetService

Formål

Servicen anvendes til at arbejde med enkeltobjekter af typen "Facet".
Servicen udstiller otte OIO-operationer.

Beskrivelse

Med servicesystemrollen ”Udstil” kan operationerne List, Læs og Soeg benyttes:

- List tager flere objekt-UUID’er som input og returnerer objekternes egenskaber. Objekters ændringer kan tilvælges.
- Læs tager et objekt-UUID som input og returnerer objektets egenskaber. Objekters ændringer kan tilvælges.
- Soeg tager et eller flere søgekriterier som input og returnerer de objekt-UUID’er, der matcher kriterierne.

Med servicesystemrollen ”Rediger” kan operationerne Importer, Opret, Passiver, Ret og Slet benyttes:

- Importer tager et objekts egenskaber inkl. objekt-UUID som input, skaber objektet med livscyklustilstand ”Importeret” og returnerer en status.
- Opret tager et objekts egenskaber ekskl. objekt-UUID som input, skaber objektet med livscyklustilstand ”Oprettet” og returnerer en status og et objekt-UUID.
- Passiver tager et objekt-UUID som input, ændrer objekts livscyklustilstand til ”Passiveret” og returnerer en status.
- Ret tager et objekts egenskaber inkl. objekt-UUID som input, opdaterer objektets egenskaber og returnerer en status.
- Slet tager et objekt-UUID som input, ændrer objektets livscyklustilstand til ”Slettet” og returnerer en status.

Servicen anvender følgende sikkerhedsmodel:
SAML Token

Eksternt testmiljø

Endpoint: https://klassifikation.eksterntest-stoettesystemerne.dk/facet/7

Produktionsmiljø

Endpoint: https://klassifikation.stoettesystemerne.dk/facet/7

Formål

Servicen anvendes til at arbejde med enkeltobjekter af typen "Facet".
Servicen udstiller otte OIO-operationer.

Beskrivelse

Med servicesystemrollen ”Udstil” kan operationerne List, Læs og Soeg benyttes:

- List tager flere objekt-UUID’er som input og returnerer objekternes egenskaber. Objekters ændringer kan tilvælges.
- Læs tager et objekt-UUID som input og returnerer objektets egenskaber. Objekters ændringer kan tilvælges.
- Soeg tager et eller flere søgekriterier som input og returnerer de objekt-UUID’er, der matcher kriterierne.

Med servicesystemrollen ”Rediger” kan operationerne Opret, Importer, Passiver, Ret og Slet benyttes:

- Opret tager et objekts egenskaber ekskl. objekt-UUID som input, skaber objektet med livscyklustilstand ”Oprettet” og returnerer en status og et objekt-UUID.
- Importer tager et objekts egenskaber inkl. objekt-UUID som input, skaber objektet med livscyklustilstand ”Importeret” og returnerer en status.
- Passiver tager et objekt-UUID som input, ændrer objekts livscyklustilstand til ”Passiveret” og returnerer en status.
- Ret tager et objekts egenskaber inkl. objekt-UUID som input, opdaterer objektets egenskaber og returnerer en status.
- Slet tager et objekt-UUID som input, ændrer objektets livscyklustilstand til ”Slettet” og returnerer en status.

Servicen anvender følgende sikkerhedsmodel:
SAML Token

Eksternt testmiljø

Endpoint: https://klassifikation.eksterntest-stoettesystemerne.dk/facet_6

Produktionsmiljø

Endpoint: https://klassifikation.stoettesystemerne.dk/facet_6

Filservice / Serviceplatformen
FælleskommunaleITsystemerLogning

Formål

Filservicen gør det muligt at overføre logningsinformation til Serviceplatformen.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Filservice / Serviceplatformen
FagsystemdefineredeDataAflever

Formål

Formålet med filservicen er, at fagløsninger kan levere et ikke-standardiseret dataudtræk med ledelsesinformation til en kommune eller andre af kommunens fagløsninger via Serviceplatformens SFTP-komponent.

Beskrivelse

Dataudtrækket er individuelt aftalt, men fagløsninger kan have valgt at offentliggøre specifikationer, som i så fald vil være tilgængelige i bilagspakken i dokumentationen.