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

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
CprLookupService_Adresse4

Formål

Servicen giver mulighed for at forespørge på et personnummer, hvorefter kontaktadresse på en given person kan returneres.

Beskrivelse

Ved forespørgsel på et personnummer returnerer servicen:
- Kontaktadresse: I klarskrift typisk postnummer, postdistrikt, vejnavn, husnummer, etage, sidedør og evt. bygningsnummer
- Administration: Startdato for forekomst samt slettedato for hvornår en forekomst skal slettes

Klarskrift på adresser på personer forekommer kun i de tilfælde, hvor der ikke må/kan oprettes en relation til et personnummer. Kontaktadressen kan indeholde både danske og udenlandske kontaktadresser.

Servicen er baseret på CPR's adresse4.

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

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

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: b7e5ee9c-1acd-41e6-b117-08a11dee6862

EntityId: http://cpr.serviceplatformen.dk/service/adresse4/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: b7e5ee9c-1acd-41e6-b117-08a11dee6862

EntityId: http://cpr.serviceplatformen.dk/service/adresse4/2

Webservice / Serviceplatformen
CprLookupService_navne3

Formål

Servicen tager et personnummer som parameter og returnerer udvalgte oplysninger om personens navn.

Beskrivelse

Servicen tager et personnummer som parameter og returnerer oplysninger om personens navn:
- Fornavn, mellemnavn, efternavne - desuden køn og status for personen (aktiv/inaktiv)
- Navnehistorik - tidligere navne markering

Servicen er baseret på CPR's service navne3 og udstiller et udsnit af CPR's service navne3's outputfelter. Følgende felter returneres ved opslag på personnummer:
CNVN_ADRNVN, CNVN_EFTERNVN, CNVN_EFTERNVNMRK, CNVN_FORNVN, CNVN_FORNVNMRK, CNVN_KOEN, CNVN_MELNVN, CNVN_MELNVNMRK, CNVN_STARTDATO, CNVN_STARTDATOUSM, CNVN_STATUS, CNVN_STATUSDATOUSM, CNVN_STATUSSTARTDAT, HISTORIKMRK.

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 sikkerhedmodel:
- Certificat - InvocationContext

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: e3f26293-803e-4b8f-8a15-674a4f8abaad

EntityId: http://cpr.serviceplatformen.dk/service/navne3/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CPRLookup/CPRLookup/2

UUID: e3f26293-803e-4b8f-8a15-674a4f8abaad

EntityId: http://cpr.serviceplatformen.dk/service/navne3/2

Webservice / Serviceplatformen
CPRMunicipalityCodeeService

Formål

Servicen kan returnere en persons bopælskommune ud fra et CPR-nummer.

Beskrivelse

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/CPRMunicipalityCode/CPRMunicipalityCode/1

UUID: cdf2d790-63ed-11e3-96c7-000c7631174f

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

Produktionsmiljø

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

UUID: cdf2d790-63ed-11e3-96c7-000c7631174f

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

Webservice / Serviceplatformen
CVROnline

Formål

Servicen giver mulighed for at tilgå kildesystemet CVR-Online.

Nyt i denne version

Servicen anvender i denne version også SAML-token (Liberty Basic SOAP Binding) som sikkerhedsmodel.

Beskrivelse

Servicen er implementeret som en SOAP-service og understøtter fem operationer:

- LegalUnitGet
- LegalUnitSearch
- ProductionUnitGet
- ProductionUnitSearch
- RelatedProductionUnitNameAndAddressGet

De fem operationer orkestrerer kald til relevante REST-services for CVR på Datafordeleren. Afhængigt af den valgte operation returneres en række oplysninger om virksomheden.

LegalUnitGet
- Opslag på CVR-nummer. Ud fra et CVR-nummer returneres bl.a. virksomhedsnavn, adresse, start- og ophørstidspunkt, reklamekode, tilknyttede P-numre og virksomhedsform.

LegalUnitSearch
- Søgning efter CVR-enhed. Ud fra en kombination af søgeparametre returneres en liste af matchende CVR-numre. Bemærk, at kun et begrænset antal søgeparametre vil fungere efter kildeændring.

ProductionUnitGet
- Opslag på P-nummer. Ud fra et P-nummer returneres bl.a. navn, adresse, start- og ophørstidspunkt, reklamekode, relateret CVR-nummer og branche.

ProductionUnitSearch
- Søgning efter P-nummer. Ud fra en kombination af søgeparametre returneres en liste af matchende P-numre. Bemærk, at kun et begrænset antal søgeparametre vil fungere efter kildeændring.

RelatedProductionUnitNameAndAddressGet
- Opslag på relateret P-nummer. Returnerer navn og adresse på relaterede P-numre.

Servicen er udstillet med følgende sikkerhedsmodeller:
- Certifikat - InvocationContext (IC)
- SAML-token

Eksternt testmiljø

Endpoint: https://exttest.serviceplatformen.dk/service/CVR/Online/2

UUID: c0daecde-e278-43b7-84fd-477bfeeea027

EntityId: http://cvr.serviceplatformen.dk/service/online/2

Produktionsmiljø

Endpoint: https://prod.serviceplatformen.dk/service/CVR/Online/2

UUID: c0daecde-e278-43b7-84fd-477bfeeea027

EntityId: http://cvr.serviceplatformen.dk/service/online/2

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