Status
Kategori
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

UUID: 266d138d-d314-441f-9bd1-a32ecf95a028

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Produktionsmiljø

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

UUID: 266d138d-d314-441f-9bd1-a32ecf95a028

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

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 / Serviceplatformen
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://exttest.serviceplatformen.dk/service/Organisation/Bruger/5

UUID: 6db357f7-9ea9-4cdd-8645-326ba94d6dff

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Produktionsmiljø

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

UUID: 6db357f7-9ea9-4cdd-8645-326ba94d6dff

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Webservice / Serviceplatformen
CprSubscriptionService

Formål

Servicen giver mulighed for, at kommunens fagsystem kan abonnere på ændringer i CPR-data for de personer, som kommunen vælger at opsætte hændelsesabonnement på.

Nyt i denne version

Version 2.0 indeholder alle felter, som modtages fra CPR-kontoret inkl. de ovenfor nævnte nye felter AdresseUUID, Delvis værgemål og Delt bopæl.

Beskrivelse

Bemærk, at denne version er under udvikling.

Servicen bygger på et fuld udtræk fra CPR-kontoret dateret 12. maj 2022 samt de ændringer, der er løbet på siden da.

Ændringsudtræk sendes fra CPR-kontoret på hverdage, hvilket betyder, at man som modtager kan forvente at modtage filer fra Serviceplatformen med ændrede persondata dagligt. Der leveres persondata med tilhørende 99 års historik.
Filerne leveres til kommunens fagsystem via fagsystemets SFTP-mappe på Serviceplatformen. For anvendelse af servicen er det derfor en forudsætning, at anvendersystemet er tilknyttet Serviceplatformens SFTP med filudvekslingstypen simpel.

CPR Abonnementet sættes op ved brug af ét eller flere filtre:
- Alder: Med dette filter modtages alle ændringer for personer, som har en alder inden for det angivne aldersinterval - eksempelvis alle personer under 18 år eller alle personer over 65 år.
- Kommunekode: Med dette filter modtages alle ændringer for personer, som er bosat inden for den/de angivne kommunekode(r), herunder tilflyttere.
- CPR-numre: Med dette filter modtages alle ændringer for personer med de angivne CPR-numre.
- Hændelseskoder: Med dette filter modtages alle CPR-data for personer, hvor der er sket ændringer inden for valgte hændelseskode – eksempelvis for alle dødsfald eller navneændringer.
- Ingen filtre: Med dette filter modtages alle ændrede CPR-data for alle personer.

Det er kommunens ansvar at sikre, at der foreligger et sagligt behov for modtagelse af CPR-data for de personer, som er specificeret i ændringsfiltrene. Ligeledes er det kommunens ansvar at sikre, at kommunens fagsystem ikke modtager CPR-data for personer, hvor der ikke længere foreligger et sagligt behov.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InnovationContext

Formål

Servicen giver mulighed for, at kommunens fagsystem kan abonnere på ændringer i CPR-data for de personer, som kommunen vælger at opsætte hændelsesabonnement på.

Beskrivelse

Ændringsudtræk sendes fra CPR-kontoret på hverdage, hvilket betyder, at man som modtager kan forvente at modtage filer fra Serviceplatformen med ændrede persondata dagligt. Der leveres persondata med tilhørende 99 års historik. Filerne leveres til kommunens fagsystem via fagsystemets SFTP-mappe på Serviceplatformen. For anvendelse af servicen er det derfor en forudsætning, at anvendersystemet er tilknyttet Serviceplatformens SFTP med filudvekslingstypen simpel.

CPR Abonnementet sættes op ved brug af ét eller flere filtre:
- Alder: Med dette filter modtages alle ændringer for personer, som har en alder inden for det angivne aldersinterval - eksempelvis alle personer under 18 år eller alle personer over 65 år
- Kommunekode: Med dette filter modtages alle ændringer for personer, som er bosat inden for den/de angivne kommunekoder, herunder tilflyttere
- CPR-numre: Med dette filter modtages alle ændringer for personer med de angivne CPR-numre
- Hændelseskoder: Med dette filter modtages alle CPR-data for personer, hvor der er sket ændringer inden for valgte hændelseskode – eksempelvis for alle dødsfald eller navneændringer
- Ingen filtre: Med dette filter modtages alle ændrede CPR-data for alle personer

Det er kommunens ansvar at sikre, at der foreligger et sagligt behov for modtagelse af CPR-data for de personer, som er specificeret i ændringsfiltrene. Ligeledes er det kommunens ansvar at sikre, at kommunens fagsystem ikke modtager CPR-data for personer, hvor der ikke længere foreligger et sagligt behov.

Servicen henter data fra Serviceplatformens lokale replika af CPR. Serviceplatformen har valgt at etablere et lokalt CPR-replika af performancemæssige og økonomiske årsager. Data i Serviceplatformens CPR-replika opdateres dagligt.

Servicen er udstillet med følgende sikkerhedsmodel:
- Certifikat - InnovationContext

Eksternt testmiljø

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

UUID: 9cdccc2f-3243-11e2-8fef-d4bed98c5934

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

Produktionsmiljø

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

UUID: 9cdccc2f-3243-11e2-8fef-d4bed98c5934

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

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 / Serviceplatformen
FacetService

Formål

Servicen udstiller OIO-operationer (Opret, Importer, Læs, Ret, Slet, Passiver, Søg og List) på forretningsobjektet Facet, dvs. på en dimension i et klassifikationssystem.

Beskrivelse

Der er otte operationer, fordelt på to grupper: Dem der ændrer i objekter (Importer, Opret, Passiver, Ret og Slet) og dem, der ikke ændrer i objekter (List, Læs og Søg).

- Importer, Passiver, Ret og Slet returnerer kun resultatet af kaldet
- Opret returnerer resultatet af kaldet samt ObjektId på den forekomst, der er blevet oprettet
- Søg og List returnerer resultatet af kaldet samt kollektioner, der indeholder ObjektRegistreringer
- Læs returnerer resultatet af kaldet samt de ObjektRegistreringer, der er efterspurgt af servicen

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

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/Klassifikation/Facet/5

UUID: 021c1a36-47a9-494f-b52e-23f96969b4d1

EntityId: http://klassifikation.serviceplatformen.dk/service/klassifikation/5

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/Klassifikation/Facet/5

UUID: 021c1a36-47a9-494f-b52e-23f96969b4d1

EntityId: http://klassifikation.serviceplatformen.dk/service/klassifikation/5

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

Webservice / Serviceplatformen
InteressefaellesskabService

Formål

Servicen giver et kommunalt fagsystem mulighed for at hente eller opdatere organisationsdata vedrørende domæneområdet ”Interessefaellesskab” 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/Interessefaellesskab/5

UUID: ec362d2e-81d9-426b-8148-66a36546a072

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Produktionsmiljø

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

UUID: ec362d2e-81d9-426b-8148-66a36546a072

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Webservice / Serviceplatformen
ItSystemService

Formål

Servicen giver et kommunalt fagsystem mulighed for at hente eller opdatere organisationsdata vedrørende domæneområdet ”ItSystem” 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/ItSystem/5

UUID: d2848370-9b21-4815-89f0-8251e20f5b7e

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Produktionsmiljø

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

UUID: d2848370-9b21-4815-89f0-8251e20f5b7e

EntityId: http://organisation.serviceplatformen.dk/service/organisation/5

Webservice / Fælleskommunalt Klassifikationssystem
KlasseService

Formål

Servicen anvendes til at arbejde med enkeltobjekter af typen "Klasse".
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/klasse/7

Produktionsmiljø

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

Formål

Servicen anvendes til at arbejde med enkeltobjekter af typen "Klasse".
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/klasse_6

Produktionsmiljø

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