Gå til hovedindhold
Webservice / Serviceplatformen
AarsopgoerelseService

Formål

Servicen udstilles som en synkron webservice på Serviceplatformen. Den giver mulighed for at lave opslag i KMD Indkomst.

Beskrivelse

Servicen er implementeret som en SOAP-webservice, hvor en forespørgsel på en persons årsopgørelse for et af de seneste tre opgjorte skatteår gennemstilles til KMD Indkomst, som leverer synkront svar tilbage til anvender.

Input:
- Et CPR-nummer pr. opslag
- Årstal
- Sagsområdekode, som aftales med KMD. Koden reflekterer desuden den lovhjemmel, hvori opslaget foretages

Output:
- Alle udfyldte felter i årsopgørelsen for det efterspurgte årstal

Et eksempel på indholdet i output finder du i dokumentationen.

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/KMD/Aarsopgoerelse/2

UUID: 491daa4c-3514-45c9-8e16-a50c466cf902

EntityId: http://kmd.serviceplatformen.dk/service/aarsopgoerelse/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/KMD/Aarsopgoerelse/2

UUID: 491daa4c-3514-45c9-8e16-a50c466cf902

EntityId: http://kmd.serviceplatformen.dk/service/aarsopgoerelse/2

Webservice / Fælleskommunalt Organisationssystem
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://organisation.eksterntest-stoettesystemerne.dk/organisation/adresse/6/

Produktionsmiljø

Endpoint: https://organisation.stoettesystemerne.dk/organisation/adresse/6/

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

UUID: 27636965-a534-4925-992d-3efa875302bd

EntityId: http://sp.serviceplatformen.dk/service/alive/2

Produktionsmiljø

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

UUID: 27636965-a534-4925-992d-3efa875302bd

EntityId: http://sp.serviceplatformen.dk/service/alive/2

Webservice / Fælleskommunal Beskedfordeler
BeskedFåTilsendt

Formål

Servicen benyttes til at automatisk få tilsendt beskeder via Beskedfordeleren (push).

Servicen forudsætter, at modtagersystemet har udstillet et REST-endpoint, som beskederne kan sendes til.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Formål

Servicen benyttes til at automatisk få tilsendt beskeder via Beskedfordeleren (push).

Servicen forudsætter, at modtagersystemet har udstillet et REST-endpoint, som beskederne kan sendes til.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

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

UUID: b1d6d5ba-4311-42eb-b10f-0a4ed8180e4d

EntityId: http://ydelse.serviceplatformen.dk/service/ydelsesindeks/5

Produktionsmiljø

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

UUID: b1d6d5ba-4311-42eb-b10f-0a4ed8180e4d

EntityId: http://ydelse.serviceplatformen.dk/service/ydelsesindeks/5

Webservice / Fælleskommunalt Ydelsesindeks
BevillingIndeksService

Formål

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

Beskrivelse

Servicen indeholder én operation:

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

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

Servicen er udstillet med følgende sikkerhedsmodel:

- OIO IDWS

Eksternt testmiljø

Endpoint: https://ydelsesindeks.eksterntest-stoettesystemerne.dk/bevillingindeks/6

Produktionsmiljø

Endpoint: https://ydelsesindeks.stoettesystemerne.dk/bevillingindeks/6

Webservice / Fælleskommunalt Organisationssystem
BrugerService

Formål

Servicen giver et kommunalt fagsystem mulighed for at hente eller opdatere organisationsdata vedrørende domæneområdet ”Bruger” 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://organisation.eksterntest-stoettesystemerne.dk/organisation/bruger/6/

Produktionsmiljø

Endpoint: https://organisation.stoettesystemerne.dk/organisation/bruger/6/

Webservice / Serviceplatformen
ContextHandlerGUIBrugerLogout

Formål

Servicen anvendes til at lave et single log-out via Context Handler. Dvs. at en slutbruger logges ud af samtlige brugervendte systemer, hvor brugeren har en aktiv session med Context Handler.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Formål

Servicen anvendes til at lave et single log-out via Context Handler. Dvs. at en slutbruger logges ud af samtlige brugervendte systemer, hvor brugeren har en aktiv session med Context Handler.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Webservice / Fælleskommunal Adgangsstyring for brugere
ContextHandlerHent

Formål

Servicen giver mulighed for at trække et SAML-token for en slutbruger med brugerens identitet, brugersystemroller og dataafgrænsningsværdier.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Formål

Servicen giver mulighed for at trække et SAML-token for en slutbruger med brugerens identitet, brugersystemroller og dataafgrænsningsværdier.

Beskrivelse

For uddybning af servicen se den vedhæftede dokumentation.

Webservice / Serviceplatformen
CPRBasicInformationService

Formål

Servicen kan fremsøge lister over personer ud fra navn eller fødselsdato samt et detaljeret personopslag inklusive adressehistorik, baseret på et personnummer.

Beskrivelse

Servicen tager et personnummer som parameter og returnerer oplysninger om personens:
- Stamdata: Bl.a. navn, status, køn, civilstand samt navne-/adressebeskyttelsesoplysninger, gældende personnummer
- Adresse: Bl.a. aktuel adresse, kontaktadresse, udlandsadresse, vejadresseringsnavn og distriktoplysninger (postdistrikt, mm.)

På samme måde som hos CPR-registret, returneres et svar med maksimalt 20 personer ad gangen. Skulle søgningen resultere i et svar med flere end 20 personer, skal servicen kaldes igen for at hente de næste 20 personer i svaret.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certificat - InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRBasicInformation/CPRBasicInformation/1

UUID: d84f1ac8-76ca-11e3-abab-138252136bdf

EntityId: http://cpr.serviceplatformen.dk/service/basic/1

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRBasicInformation/CPRBasicInformation/1

UUID: d84f1ac8-76ca-11e3-abab-138252136bdf

EntityId: http://cpr.serviceplatformen.dk/service/basic/1