Gå til hovedindhold
Webservice / Serviceplatformen
DebitorIndbetalingAfsend

Formål

Formålet med servicen er at give et fagsystem mulighed for at foretage indbetaling på fordringer i kommunens debitorsystem. Desuden giver den mulighed for at fremsøge fordringer, der kan indbetales på.

Servicen vil ofte anvendes af fagsystemet i kombination med beskedservicen FordringTilIndbetalingHent eller -Modtag.

Beskrivelse

Servicen omfatter beskedtypen: FordringTilIndbetaling

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorIndbetalingAfsend/1

UUID: d0ed926d-be52-4b12-bf4a-0513b594eed5

EntityId: http://oir.serviceplatformen.dk/service/debitorindbetalingafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorIndbetalingAfsend/1

UUID: d0ed926d-be52-4b12-bf4a-0513b594eed5

EntityId: http://oir.serviceplatformen.dk/service/debitorindbetalingafsend/1

Webservice / Serviceplatformen
DebitorkontoAnmodningAfsend

Formål

Denne service muliggør, at et fagsystem kan oversende en anmodning til et debitorsystem om at foretage en handling.

Udgangspunktet for alle servicens operationer er en debitorkonto.

Beskrivelse

Servicen understøtter, at et fagsysteme kan oprette en anmodning om en handling, som involverer en eller flere af fagsystemets debitorkonti i myndighedens debitorsystem. Servicens anvendes, når fagsystemet har behov for, at opkrævningsfunktionen - her repræsenteret ved debitorsystemet - udfører handlinger på fagsystemets debitorkonti, som kun debitorsystemet har adgang til at udføre.

I svaret på anmodningen får fagsystemet besked om, at handlingsønsket kan accepteres og evt. resultatet af handlingen, hvis der er tale om en her og nu handling. Handlingen kan dermed også gennemføres tidsforskudt for accepten af anmodning. Resultatet af handlingen vil i det tilfælde sendes af debitorsystemet til fagsystemet i en selvstændig svarservice.

Servicen understøtter fire varianter af debitorkontoanmodninger:

1. Anmodning om handling på én debitorkonto. Det kan dreje sig om massehandlinger på alle objekter af en given type under debitorkonto.
2. Anmodning om handling på en eller flere udspecificerede fordringer under en debitorkonto. Handlingerne vil dreje sig om tilstandsændringer på de specificerede fordringer eller massehandlinger på objekter under disse fordringer.
3. Anmodning om handlinger mellem to debitorkonti. Handlinger vil ofte skulle bruges til at flytte værdier fra objekter på den ene debitorkonto til tilsvarende objekter på den anden debitorkonto.
4. Anmodning om handlinger mellem udpegede fordringer på to debitorkonti. Handlinger vil ofte skulle bruges til at flytte værdier fra objekter på sættet af fordring på den ene debitorkonto til tilsvarende objekter på det sæt af fordringer, der er angivet som handlingens mål.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningAfsend/1

UUID: 6f93bebe-9898-11ed-b537-1706599258b5

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningAfsend/1

UUID: 6f93bebe-9898-11ed-b537-1706599258b5

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningafsend/1

Webservice / Serviceplatformen
DebitorkontoAnmodningSvarAfsend

Formål

Service til oversendelse af asynkront svar på en DebitorkontoAnmodning.

Beskrivelse

Servicen understøtter, at debitorsystemet kan afsende et forretningssvar til et fagsystem på resultatet af den handling, som er affødt af en debitorkontoanmodning, som fagsystemet tidligere har oprettet i myndighedens debitorsystem.

Afgivelse af forretningssvar forudsætter, at debitorsystemet tidligere har kvitteret med accept på debitorkontoanmodning til senere behandling.

Fagsystemet kan bruge svaret til håndtering af egne processer, der afventer den endelige tilbage-melding på en debitorkontoanmodning.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningSvarAfsend/1

UUID: 9ab5d456-9898-11ed-9b1c-eb4fae236c62

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningsvarafsend/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorkontoAnmodningSvarAfsend/1

UUID: 9ab5d456-9898-11ed-9b1c-eb4fae236c62

EntityId: http://oir.serviceplatformen.dk/service/debitorkontoanmodningsvarafsend/1

Webservice / Serviceplatformen
DebitorRegistreringAfsend

Formål

Servicen understøtter, at fagsystemet kan oprette og ajourføre sine krav i kommunens debitorsystem. Servicen understøtter her og nu dataudveksling, straksleverance, af debitorregistreringer under en debitorkonto.

Nyt i denne version

Ændringer i Operationen OpretDebitorkontoRegistrering:
- Operationen indeholder nu muligheden for at kunne registrere omkostningsfordringer, der er afledt af andre fordringer, fx lånerenter. Operationen understøtter, at disse særlige fordringer kan pege på den fordring, de er afledt af og dermed muliggøres korrekt overførsel af denne slags fordringer til inddrivelse i PSRM.
- Nogle lånetyper kræver ifm. med oversendelse til inddrivelse i PSRM, at den oprindelige hovedstol er oversendt fra fagsystemet sammen med lånefordringen. Det er nu understøttet.
- Andre PSRM-krav er yderligere understøttet, bla. på området for tilbagebetalingspligtige ydelser.
- Operationen understøtter, at krediteringer (nedreguleringer af fordringer) kan suppleres af en fritekst til skyldner om, hvad det er, der krediteres for. Det betyder fx at biblioteker nu kan udspecificere hvilke bøger en borger får godtgjort sin erstatning for.
- Ift. EDI-fakturering, har fagsystemet fremover mulighed for at referere til et ordrenummer hos modtageren af fakturaen. Der kan også specificeres en ydelsesmodtager. Det sidste er relevant ift. mellemkommunal fakturering.

Operationen OverdragDebitorkonto udgår.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorRegistreringAfsend/3

UUID: d9f6680a-a636-486b-b8ae-1ea8dc65e26c

EntityId: http://oir.serviceplatformen.dk/service/debitorregistreringafsend/3

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorRegistreringAfsend/3

UUID: d9f6680a-a636-486b-b8ae-1ea8dc65e26c

EntityId: http://oir.serviceplatformen.dk/service/debitorregistreringafsend/3

Formål

Servicen understøtter, at fagsystemet kan oprette og ajourføre sine krav i kommunens debitorsystem. Servicen understøtter her og nu dataudveksling, straksleverance, af debitorregistreringer under en debitorkonto.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/OIR/DebitorRegistreringAfsend/2

UUID: f5a2be30-a6e2-4162-86e9-9e6a756e8060

EntityId: http://oir.serviceplatformen.dk/service/debitorregistreringafsend/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/OIR/DebitorRegistreringAfsend/2

UUID: f5a2be30-a6e2-4162-86e9-9e6a756e8060

EntityId: http://oir.serviceplatformen.dk/service/debitorregistreringafsend/2

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/demo/DemoService/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 / Serviceplatformen
DokumentIndeksService

Formål

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

Beskrivelse

Servicen indeholder fire operationer, hvoraf kun to er relevante at anvende:

- 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.

- Passivér – er under udfasning og må ikke anvendes. Anvend i stedet servicen SagDokumentIndeksService.

- Slet – er under udfasning og må ikke anvendes. Anvend i stedet servicen SagDokumentIndeksService.

Servicen er udstillet med følgende sikkerhedsmodeller:

- Certifikat - AuthorityContext
- SAML-Token

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/SagDokument/DokumentIndeks/5

UUID: b4a2e66a-f2e8-11e8-8eb2-f2801f1b9fd1

EntityId: http://sagdokument.serviceplatformen.dk/service/sagdokumentindeks/5

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/SagDokument/DokumentIndeks/5

UUID: b4a2e66a-f2e8-11e8-8eb2-f2801f1b9fd1

EntityId: http://sagdokument.serviceplatformen.dk/service/sagdokumentindeks/5

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