Gå til hovedindhold
Webservice / Serviceplatformen
AdresseService

Formål

Servicen giver et kommunalt fagsystem mulighed for at hente eller opdatere organisationsdata vedrørende domæneområdet ”Adresse” i Organisation.

Beskrivelse

Servicen indeholder i alt 8 operationer, der kan deles op i to kategorier:
- 5 operationer, der ændrer i objekter (importer, opret, passiver, ret og slet)
- 3 operationer, der ikke ændrer i objekter (list, laes og soeg).

Yderligere beskrivelse af input- og outputparametre for de 8 operationer af forretningsobjektet Organisation, finder du i dokumentationen.

Servicen er udstillet med følgende sikkerhedsmodel:
- SAML-Token

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/Organisation/Adresse/5

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/Organisation/Adresse/5

Webservice / Serviceplatformen
AliveService

Formål

Servicens formål er at give en teknisk status på en række af Serviceplatformens komponenter og services.

Beskrivelse

Servicen består af to operationer:

1. callAliveServicePing: Med operationen kan man "pinge" en række af Serviceplatformens komponenter og services:
- Applikationsserver
- Administrationsmodul
- Batch-server
- SFTP-server
- Eksternt udstillede services (baseret på service UUID)

2. callAliveServiceHistory: Med operationen kan man tjekke ændringshistorik på eksternt udstillede services.

Servicen er udstillet med følgende sikkerhedmodeller:
- Certifikat – invocationContext
- Certifikat - AuthorityContext
- SAML-token

For uddybning af integrationen se den vedhæftede dokumentation.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/SP/Alive/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/SP/Alive/2

Beskedservice / Fælleskommunal Beskedfordeler
ArbejdsskadesagHændelseBeskedHent

Formål

Servicen giver anvender mulighed for at oprette abonnement på og modtage beskeder med oprettelse af og ændringer i arbejdsskadesager fra AES.

Servicen anvender pull-mønster, dvs. at man som anvendersystem skal hente beskeden fra Beskedfordeleren.

Beskrivelse

Servicen udstiller beskedtypen AES_SagshaendelserFraAES version 1.0.

Beskedservice / Fælleskommunal Beskedfordeler
ArbejdsskadesagHændelseBeskedModtag

Formål

Servicen giver anvender mulighed for at oprette abonnement på og modtage beskeder med oprettelse af og ændringer i arbejdsskadesager fra AES.

Servicen anvender push-mønster, dvs. at man som anvendersystem skal installere en service til at modtage beskeden fra Beskedfordeleren.

Beskrivelse

Servicen udstiller beskedtypen AES_SagshaendelserFraAES version 1.0.

Webservice / Fælleskommunal Beskedfordeler
BeskedfordelerAfhent

Formål

Servicen er en logisk repræsentation af den AMQP-service, som et abonnerende system skal kalde for at kunne hente beskeder via pull fra Beskedfordeleren.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Webservice / Fælleskommunal Beskedfordeler
BeskedfordelerAflever

Formål

Servicen er en logisk repræsentation af den AMQP-service, som skal anvendes for at kunne afsende en besked via Beskedfordeleren.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Webservice / Fælleskommunal Beskedfordeler
BeskedfordelerService

Formål

Servicens formål er, at en abonnent af beskeder fra Beskedfordeleren kan vedligeholde værdilister for sine abonnementer. Fx hvilke borgere (personer) man ønsker at abonnere på hændelser for.

Nyt i denne version

Første majorversion.

Beskrivelse

Anvendersystem skal kalde servicen for at tilgå værdilister for sine abonnementer.

Det er muligt at søge og slå op med følgende operationer:
- List
- Laes
- Soeg

Værdilisten kan ændres med følgende operationer:
- Importer
- Opret
- Passiver
- Ret
- Slet
- TilfoejVærdier
- FjernVærdier

Beskedfordeler svarer tilbage til anvendersystemet med returdata for den respektive operation.

Filservice / Serviceplatformen
BetalingsadministrationForspørgselSend

Formål

Servicen giver løsningen KY mulighed for at overføre filer med forespørgsler på en kommunes betalingsadministrationsaftaler til løsningen UDK Debitor.

Servicen indgår i et asynkront flow med BetalingsadministrationSvarHent.

Beskrivelse

Filoverførslen består af en fil i fast format, som indeholder forespørgsler på en kommunes betalingsadministrationsaftaler. Der sendes en fil pr. kommune.

Filen indeholder en samlet forespørgsel for kommunen. Forespørgslen er angivet i fast format med en fastlagt længde.

Filservice / Serviceplatformen
BetalingsadministrationSvarHent

Formål

Servicen giver løsningen UDK Debitor mulighed for at overføre filer med betalingsadministrationsaftaler for de personer, som skal have tilbageholdt beløb i udbetalingerne, til løsningen KY.

Servicen indgår i et asynkront flow med BetalingsadministrationForspørgselSend.

Beskrivelse

Filoverførslen består af en fil i fast format, som indeholder informationer om betalingsadministrationsaftaler for de personer, som skal have tilbageholdt beløb i udbetalingerne. Der sendes en fil pr. kommune.

Filen indeholder alle transaktioner for den pågældende kommune, som hver er angivet i fast format med en fastlagt længde.

Webservice / Serviceplatformen
BevillingIndeksService

Formål

Servicen anvendes til fysisk sletning af forretningsobjekter af typen Bevilling og tilhørende Økonomiske Effektueringer i Ydelsesindeks.

Beskrivelse

Servicen indeholder tre operationer, hvoraf kun én er relevant at anvende:

- Fjern – anvendes til fysik sletning af et eller flere forretningsobjekter af typen Bevilling og tilhørende Økonomiske Effektueringer.

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

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

For at importere, opdatere og fremsøge forretningsobjekter af typen Økonomisk Effektuering anvendes servicen YdelsesIndeksService.

Servicen er udstillet med følgende sikkerhedmodeller:

- Certifikat - AuthorityContext
- SAML-Token

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/Ydelse/BevillingIndeks/5

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/Ydelse/BevillingIndeks/5