Oprindelig kilde Datafordeleren
Forfatter Datafordeleren
Oprettet Jun 26, 2019
Version 1.0
Ændret Oct 30, 2023
Sidehistorik





Denne side beskriver hvordan du anvender REST-service på Datafordeleren.

Har brug for en generel og mere teknisk indføring i REST-service på Datafordeleren kan du læse mere på REST på Datafordeleren og Retningslinjer for REST-tjenester.

BEMÆRK

På Datafordeleren er der ikke konfigureret timeout på webtjenester.





Hent data med en REST-service

Vælg en tjeneste

Til toppen

Brug Dataoversigten til at finde den ønskede tjeneste. Her kan du finde oplysninger om hvilken brugeradgang den ønskede tjeneste kræver. 

Læs mere om Brugeroprettelse og Brugeradgang på Datafordeler.dk.



Find url'en til din tjeneste


Under hver enkelt tjeneste på Datafordeleren i Dataoversigten og i servicekatalogerne er angivet den url, som du skal bruge for at kalde tjenesten. 



Tilføj inputparametre til din url


I servicekatalogerne er for hver enkelt tjeneste angivet, hvilket inputparametre, som det er muligt at benytte samt deres defaultværdier.




Læs mere om parametre på REST på Datafordeleren.

TYPER AF PARAMETRE OG DEFAULT VÆRDIER

De registerspecifikke servicekataloger er knyttet til de specifikationer, som registret har specificeret i deres Dataleverancespecifikation (DLS). 

For hver parameter er dens type angivet. Der benyttes følgende typer:

  • UUID
  • Liste af værdier af typen UUID
  • String
  • Liste af værdier af typen String
  • Integer
  • Liste af værdier af typen Integer
  • DateTime
  • Date
  • Boolean
  • Double

De enkelte værdier i lister adskilles af et ”|”-tegn (pipe karakter).

For hver ikke-obligatorisk parameter er der en default værdi. Hvis parameteren udelades i et kald til en tjeneste, så benytter tjenesten default værdien for parameteren ved behandling af kaldet. I de registerspecifikke servicekataloger er angivet default værdier for hvert enkelt parameter.





Kald din tjeneste


Bemærk, at det er din tjenstebrugers brugernavn og adgangskode, som du skal indsætte i url'en, hvis du benytter brugernavn/adgangskode.

Du kan nu søge med url'en i en browser eller benytte den indarbejdede url i din applikation.






Selvbetjeningen

Log på Selvbetjeningen

Til toppen

Log på Selvbetjeningen med den ønskede webbruger og anmod eventuelt om adgang til de begrænsede tjenester via din tjenestebruger, som du finder under det overordnede menupunkt BRUGERE.




Få en oversigt over tjenester


Du kan på Selvbetjeningen under menupunktet TJENESTER få et overblik over eksisterende tjenester.

Listen kan afgrænses ved at vælge et registre.

Det anbefales at benytte Dataoversigten til at danne sig et overblik.







Se detaljer for en tjeneste


Vælg den ønskede tjeneste i resultatlisten.

Detaljer for tjenesten vises i højre side, og den valgte tjeneste bliver highlightet i resultatlisten.




DETALJER FOR TJENESTE

  • Tjenestenavn
    Teknisk navn for tjenesten
  • Visningsnavn
    Brugervendt navn for tjenesten
  • Udgave
    Version
  • Registermyndighedens navn
    Bemærk, at det pt. er navn på registeret, der bliver vist, og IKKE Registermyndigheden.
  • Atom feed med info om nye versioner
    Oplysninger om Atom feed for tjenesten, som kan benyttes til at oprette et abonnement.
  • Webservice url
    Angiver den ul, der skal benyttes for at tilgå tjenesten.
  • Detaljer
    Kan indeholde beskrivelse og detaljer for tjenesten.



Opret Atom feed


Som webbruger har du mulighed for at blive adviseret, når en ny version af en given tjeneste publiceres.

Du kan finde oplysninger om Atom feeds under detaljevisningen.

Du kan åbne Atom feeds i din browser og abonnere på feeds ved hjælp af din browser eller feed reader.

Bemærk at det er forskelligt fra browser til browser, hvordan Atom feed bliver præsenteret, og hvordan links i Atom feed bliver håndteret.

Du har nu opsat et feed abonnement og vil blive adviseret, når en ny version af tjeneste publiceres.