Denne side beskriver adgangen til og den tekniske distribution af fildownload, som er gældende for alle registre på Datafordeleren, der udstiller data med fildownload.

Anvendere kan benytte fildownload til at hente tre forskellige typer data:

  • Tabulære data (entitetsbaserede fildownload)
  • Rasterdata (rasterbaserede fildownload)
  • Punktskydata (punktskybaserede fildownload)


Sideinformation


Begreber


På siderne om fildownload bruges nedenstående begreber. Bemærk at begreberne også bliver yderligere forklaret med eksempler på siderne .

Begreb

Beskrivelse

Nuværende Datafordeler

Filudtræk:

Filudtræk er en metode til at få udtræk af data fra Datafordeleren. Man kan som anvender logge på selvbetjeningen og oprette et abonnement på et specifikt filudtræk – evt. med brugerdefinerede parametre, hvorefter filen bliver genereret og er tilgængelig på en FTP-server. Filudtræk er beskrevet på Filudtræk på Datafordeleren.

Moderniserede Datafordeler

Fildownload:

Fildownload beskrives i denne vejledning.

Entitet:

En entitet er en fysisk repræsentation af et registerobjekt som findes i Grunddatamodellen. De total- og deltadownload der kan hentes fra Datafordeleren, indeholder hver især data bestående af en enkelt entitet.

Totaldownload:

Et totaldownload er et udtræk af alle data for en enkelt entitet og refererer til en enkelt fil.

Deltadownload:

Et deltadownload er et udtræk af alle data der har ændret sig, siden forrige deltadownload blev lavet, for en enkelt entitet. Et deltadownload består af en enkelt fil.

Totaludtræk:

Et totaludtræk er et udtræk af alle data i et register eller en delmængde af entiteter fra et register. Et totaludtræk er udgjort af en eller flere totaldownloads. Et totaludtræk kan således bestå af en eller flere filer med tilsvarende entiteter, alt afhængigt af hvor stor en delmængde af et register der er tale om. Bemærk at denne definition kun gælder for fildownload.

Deltaudtræk:

Et deltaudtræk er et udtræk af alle data der har ændret sig, siden forrige deltaudtræk blev lavet, i et register eller en delmængde af entiteter fra et register. Et deltaudtræk er udgjort af et eller flere deltadownloads. Et deltaudtræk kan således bestå af en eller flere filer med tilsvarende entiteter, alt afhængigt af hvor stor en delmængde af et register der er tale om.

Tabulære data

Tabulære data er en bestemt type data, som består af strukturerede data der repræsenteres i kolonner og rækker og samles i tabeller.

Rasterdata

Rasterdata er en bestemt type data, der bruger et grid af celler eller pixels til at repræsentere information. Rasterdata kaldes også billeddata. På Datafordeleren repræsenterer rasterdata udelukkende geografiske data.

Punktskydata

Punktskydata er en bestemt type data, der består af et set af datapunkter i et 3-dimensionelt koordinatsystem. Hvert punkt repræsenterer en enkelt geografisk måling på overfladen af et objekt. Samlet set repræsenterer en punktsky hele det pågældende objekts overflade.





Entitetsbaserede fildownload


Om entitetsbaserede fildownload


Entitetsbaserede fildownload er en funktionalitet på Datafordeleren til udstilling af data, men skal ikke misforstås som værende det samme som de abonnementsbaserede filudtræk, der også er på Datafordeleren. Fildownload tilbydes som prædefinerede entitetsbaserede fildownloads og baserer sig på de datamodeller som registrene har på Datafordeleren.

En entitet svarer til en tabel i Grunddatamodellen som er defineret i registrenes datamodel: https://grunddatamodel.datafordeler.dk/. En entitet kan eksempelvis være en "Adresse" fra DAR, en "Bygning" fra BBR eller et "Jordstykke" fra MAT. Det at fildownload er entitetsbaserede betyder at et fildownload indeholder data for en enkelt type af entitet. Der leveres entitetsbaserede fildownload på tabulære data og ikke for rasterdata (billeddata). Tabulære data forstås som strukturerede data der kan opbevares i tabeller, som fx adresser men ikke billedtyper som skærmkort.

Fildownload genereres løbende i bestemte intervaller for en række registre, hvorefter filerne kan hentes gennem et REST-API, der udstiller de genererede fildownload. Det eneste krav til at hente fildownload er, at man er autentificeret. Dette kan enten være i form af en tjenestebruger med brugernavn og adgangskode eller en API-key –  såfremt man ikke forsøger at hente adgangsbegrænset data – eller ved en af de to OAuth autentifikationsmetoder. Læs mere om autentifikation for fildownload.

Fildownload bruger ikke abonnementer, da de allerede ligger klar til at blive hentet. REST-API'et beskrives nærmere i afsnittet Sådan henter du fildownload, mens skema for generering samt frekvenser for generering beskrives nærmere i afsnittet Skema for generering af fildownload.



En opsummering hvad fildownload består af, kan ses i ovenstående figur. Figuren viser 3 registre:

  • Register A, som har 5 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret og har også en enkelt reference til en entitet i register C udenfor registeret.
  • Register B, som har 6 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret og har også en enkelt reference til en entitet i register A udenfor registeret.
  • Register C, som har 6 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret.

Registrenes entiteter har alle fildownload, som både består af totaldownload og deltadownload. Det skal her bemærkes at Register C har fravalgt at der bliver genereret fildownload for deres entitet nr. 5 og 6 i dette eksempel.






Typer af entitetsbaserede fildownload


Datafordeleren udstiller flere typer af entitetsbaserede fildownload. Der findes 2 typer af fildownload, nemlig totaldownload og deltadownload. Totaldownload udstilles også som kommuneopdelte fildownload, som et totaldownload med aktuelle data per kommune. Datafordeleren opbevarer ét totaldownload (inklusiv kommuneopdelte) pr. type pr. entitet, mens der opbevares deltadownload 14 dage fra de blev genereret.

Hvis der genereres fildownload for en entitet, bliver der altid genereret både totaldownload og deltadownload, med undtagelse af CVR, hvor der ikke bliver genereret deltadownload. Kommuneopdelte fildownload genereres ligeledes kun som totaldownload, og kun for de registre der beskrives under Kommuneopdelte fildownloads.

Udover at der findes flere typer af fildownload, findes der også flere typer af filtreringer på den data som de genererede fildownload indeholder. Dette skyldes at delmængder af data på Datafordeleren er bitemporal og at der dermed kan være flere forekomster af det samme objekt over tid i to tidsdimensioner.

  • Fuldt bitemporalt fildownload: Et fuldt bitemporalt fildownload inkluderer alt, hvad angår både registreringstid og virkningstid.
  • Temporalt fildownload: Et temporalt fildownload filtrerer registreringsdimensionen fra, men beholder virkningsdimensionen.
  • Fildownload med aktuelle data: Både registreringstiden og virkningstiden er sat til at være på det pågældende tidspunkt fildownload blev lavet.

Det er muligt at kombinere en type fildownload med en type af bitemporal filtrering og filformat. En opsummering af, hvilke fildownload der eksisterer kan ses i nedenstående tabel.

Type af fildownload

Type af bitemporal filtrering

Kommuneopdelte

Typer af filformater

Totaldownload

Bitemporal

Nej

JSON, CSV, GML og GPKG

Totaldownload

Temporal

Nej

Totaldownload

Aktuel

Ja (per register DLS)

Deltadownload

Bitemporal

Nej






Filformater


Nedenstående tabel viser, hvilke registre der har fildownload på deres entiteter, samt hvilke filformater der er tilgængelige for registrenes entiteter. Et kryds i en række i tabellen indikerer at filformatet generelt er understøttet for det givne registers entiteter.

Register

Forkortelse

JSON

GPKG

GML

CSV

Bygnings- og Boligregistret

BBR

X



X

Det Centrale Personregister

CPR

X



X

Danmarks Administrative Geografiske Inddeling

DAGI

X

X

X

X

Danmarks Adresseregister

DAR

X



X

Danmarks Fikspunktregister

FIKSPUNKT

X

X

X

X

DHM Højdekurver

DHMhoejdekurver

X

X

X

X

DHM Oprindelse

DHMOprindelse

X

X

X

X

Danske Stednavne

DS

X

X

X

X

Det Centrale Virksomhedsregister

CVR

X



X

Ejendomsbeliggenhedsregistret

EBR

X



X

Ejendomsvurdering

VUR

X



X

Ejerfortegnelsen

EJF

X



X

GeoDanmark Vektor

GEODKV

X

X

X

X

Matriklen2

MAT

X

X

X

X

Skatteforvaltningens Virksomhedsregister

SVR

X



X

Det skal bemærkes det ikke er alle entiteter for et register der har fildownload i GPKG og GML-format, selvom dette er indikeret i tabellen. Der skal gøre sig følgende gældende for at en entitet understøttes i GPKG eller GML-format:

  • GPKG-formatet understøttes på en entitet hvis entiteten indeholder 0 eller 1 geometrier.
  • GML-formatet understøttes på en entitet hvis entiteten indeholder minimum 1 geometri.

Bemærk

GPKG-formatet understøttes på entiteter uden geometri for at gøre dem tilgængelige i et format, der nemt kan importeres i en database og bruges til at sammenkæde med andre entiteter og datasæt.

Bemærk

Henter du fildownload i GML-formatet indeholder zip-filen også skemafilen (XSD'en) for entiteten.

Har du brug for entitetens skemafil skal du derfor hente den i GML-formatet.






Udtræksnumre


Udtræksnumre er en fortløbende talrække der beskriver tidsmæssig sammenhæng mellem data i et register. Hver gang der genereres fildownload for et register, påsættes alle fildownload ved samme generering det samme udtræksnummer. Dette bevirker at fildownload med det samme udtræksnummer indeholder konsistente data indenfor registerets egen data. Denne egenskab er særlig relevant hvis man som anvender er interesseret i at sammensætte data fra flere entiteter i et register.

Det er her vigtigt at understrege, at udtræksnumrene kun er fortløbende per register, og at hvert register derfor har sin egen fortløbende talrække, der er uafhængig af andre registre. Udtræksnumre kan derfor ikke garantere referentiel integritet på tværs af registrenes data, da dette afhænger af registrenes indlæsningstidspunkter, samt indlæsningsfrekvens.

Sammenhæng mellem total- og deltaudtræk

Det er muligt at vedligeholde en lokal kopi af registrenes data som findes på Datafordeleren ved at hente totaludtræk – og herefter løbende hente deltaudtræk.

Kopien etableres først lokalt, ved at hente totaldownload for den/de entiteter der er interesse for, for at skabe totaludtrækket. Idet totaludtrækket er hentet, skal det bemærkes hvilket udtræksnummer totaludtrækket har, da udtræksnummeret skal bruges til at identificere hvilke deltadownload der er relevante at hente, for at skabe det samlede deltaudtræk der kan opdatere den initiale kopi af data. Et totaldownload og deltadownload med det samme udtræksnummer indeholder data fra samme generation. Dette betyder at deltaudtræk med samme udtræksnummer som et totaludtræk indeholder dermed ingen data som ikke også er indeholdt i totaludtrækket. Det udtræksnummer der skal bruges til at opdatere kopien af data, er dermed det næste udtræksnummer i talrækken.

Et eksempel på dette kan ses i nedenstående figur, som viser en række genererede deltaudtræk, samt et genereret totaludtræk. Hver generering har resulteret i, at der enten er blevet genereret et deltaudtræk og/eller et totaludtræk. Det kan ses på figuren, at der eksisterer både et totaludtræk, samt et deltaudtræk med udtræksnummeret 3 og 10. Såfremt det ønskes at etablere en kopi af data fra entiteten, kan totaludtrækket med udtræksnummeret 3 først hentes – og så herefter hente deltaudtrækkene med udtræksnummer 4, 5 og 6 for at vedligeholde datakopien. Det er således ikke nødvendigt at hente deltaudtrækket med udtræksnummer 3, da deltaudtrækket blev genereret på samme tid som totaludtrækket.





Spring i udtræksnumre

Dette afsnit er særligt relevant for anvendere, der implementerer programmel, som anvender udtræksnumre til at indhente fildownload automatisk. Der kan i sjældne tilfælde forekomme et spring i udtræksnumre. Dette skyldes, at der eksisterer et nyere udtræksnummer for det pågældende register, og at generering af fildownload, derfor, vil bruge det nyere udtræksnummer for at sikre konsistente data inden for registeret.

Processen for indhentning af deltaudtræk bør, på baggrund af ovenstående, følge følgende logik:

  1. Tjek hvilket udtræksnummer der er påsat senest indhentede deltaudtræk.
  2. Indhent deltaudtræk med udtræksnumre der er større end det sidst indhentede deltaudtræks udtræksnummer.
    1. Dette sikrer at alle nyere deltaudtræk altid hentes uden at der springes nogle over, selvom der sker spring i udtræksnummeret på deltaudtrækkene. 






Navngivning af fildownload


De fildownload der genereres på Datafordeleren følger alle en navnestandard, der hjælper med at beskrive hvad indholdet af filen er. Navnestandarden ser ud som set på nedenstående figur.



Et fildownload som følger navnestandarden kan derfor eksempelvis have navn som følgende:

  1. DAR_V1_Adresse_TotalDownload_JSON_Bitemporal_10.zip
  2. DAR_V1_Adresse_DeltaDownload_JSON_Bitemporal_11.zip
  3. BBR_V1_Bygning_TotalDownload_JSON_Temporal_123.zip
  4. MAT_V1_Lodflade_TotalDownload_GPKG_Current_7.zip
  5. DAGI_V1_Kommuneinddeling_TotalDownload_GML_Current_42.zip


Man kan ud fra navngivningen af ovenstående fildownload udlede følgende:

  • Fildownload nr. 1 indeholder et fuldt bitemporalt totaldownload af Adresse-entiteten som ligger i DAR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Filen har udtræksnummer 10.
  • Fildownload nr. 2 indeholder et fuldt bitemporalt deltadownload af Adresse-entiteten som ligger i DAR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Deltafilen har udtræksnummer 11 og ville derfor indeholde alle ændringer der var sket for Adresse-entiteten siden udtræksnummer 10. Denne deltafil ville derfor kunne bruges til at opdatere en datakopi der havde indlæst fildownload nr. 1, som har udtræksnummer 10.
  • Fildownload nr. 3 indeholder et temporalt totaldownload af Bygning-entiteten som ligger i BBR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Filen har udtræksnummer 123.
  • Fildownload nr. 4 indeholder et totaldownload med aktuelle data af Lodflade-entiteten som ligger i MAT. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en GPKG-fil. Filen har udtræksnummer 7.
  • Fildownload nr. 5 indeholder et totaldownload med aktuelle data af Kommuneinddeling-entiteten som ligger i DAGI. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en GML-fil. Filen har udtræksnummer 42.




Et kommuneopdelte fildownload har et ekstra felt for kommunekode og kan f.eks. være:

  1. BBR_V3_Enhed_0430_TotalDownload_CSV_Current_307.zip
  2. GeoDKV_V3_Bassin_0530_Totaldownload_JSON_Current_226.zip

Man kan ud fra navngivningen af ovenstående fildownload udlede følgende:

  • Fildownload nr. 1 indeholder et totaldownload med aktuelle data der tilhører kommunekode 0430 af Enhed-entiteten som ligger i BBR. Filen der downloades, er en ZIP-fil, men ZIP-filen indeholder en CSV-fil. Filen har udtræksnummer 407.
  • Fildownload nr. 2 indeholder et totaldownload med aktuelle data der tilhører kommunekode 0530 af Bassin-entiteten som ligger i GEODKV. Filen der downloades, er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Filen har udtræksnummer 226.






Generering af fildownload


Skemaet nedenfor viser, hvornår der genereres fildownload for registrene på Datafordeleren. Bemærk at et register kan have frabedt sig at få genereret fildownload for bestemte entiteter i deres datamodel og vil således ikke blive genereret efter skemaet. Lige så snart et fildownload er genereret, vil det være tilgængeligt igennem REST-API'et, som udstiller fildownload. REST-API'et beskrives nærmere i afsnittet Sådan henter du fildownload.

Register

Type af fildownload

Genereres hvornår (mellem kl. 3 og 6 om natten)

EBR

Totaldownload

Lørdag

DAR

Totaldownload

Lørdag

BBR

Totaldownload

Lørdag

CVR

Totaldownload

Lørdag

MAT

Totaldownload

Søndag

DAGI

Totaldownload

Søndag

GEODKV

Totaldownload

Søndag

VUR

Totaldownload

Søndag

CPR

Totaldownload

Søndag

DS

Totaldownload

Mandag

DHMOprindelse

Totaldownload

Mandag

DHMHoejdekurver

Totaldownload

Mandag

FIKSPUNKT

Totaldownload

Mandag

EJF

Totaldownload

Mandag

SVR

Totaldownload

Mandag

Alle registre (undtaget CVR)

Deltadownload

Hver nat



Såfremt, at der genereres et deltadownload, men der ikke er sket dataændringer siden sidste gang, hvor der blev genereret et deltadownload for en pågældende entitet, vil deltadownloadet være tomt.

Hvis der genereres et totaldownload, uden at der er sket dataændringer siden sidste gang, det blev genereret, vil det nye totaldownload i JSON-, GML-, CSV-, eller GPKG-format have et ældre udtræksnummer i sit filnavn end den zip-fil den er indeholdt i.

Eksempelvis er det muligt at hente en fil med følgende navn:

  • DAR_V1_Adresse_Total_JSON_Bitemporal_10.zip

Her er udtræksnummeret på ZIP-filen 10, men ZIP-filen kan godt indeholde en JSON-fil med følgende navn:

  • DAR_V1_Adresse_Total_JSON_Bitemporal_9.json

JSON-filen har et lavere udtræksnummer end ZIP-filen, da der ikke er sket nogen ændringer i data siden sidste totaludtræk blev genereret for Adresse-entiteten. Såfremt der heller ikke sker nogen ændringer i Adresse-entiteten inden næste generering, vil ZIP-filen få udtræksnummer 11, mens den indeholdte JSON-fil stadig vil have udtræksnummer 9.

Bemærk

Dette sker kun for bitemporale totaldownloads. Der genereres altid et nyt totaldownload med temporal og aktuelle data, grundet at data kan ekskluderes uden dataændringer på grund af de bitemporale modellerne. 




Hvornår slettes et fildownload på Datafordeleren


Et totaldownload slettes når følgende kriterier er opfyldt:

  1. Udløbsdatoen (ExpirationDate) er overskredet, og 
  2. en nyere version af samme "gruppe" af totaldownload er tilgængelig til anvendere.

"Gruppe" referer til alle filer, som er samme version, entitet, replikeringskanal, datatype og format. Totaldownload bliver grupperet for at sikre, at der altid er et tilgængeligt totaldownload for alle totaldownloadsgrupper, hvis der ikke er genereret et nyt totaldownload før et download er udløbet.

Et deltadownload slettes hvis:

  1. Udløbsdatoen (ExpirationDate) er overskredet

Deltadownload bliver genereret dagligt og opbevares i 14 dage, hvorefter de bliver slettet. 





Fildownload med adgangsbegrænsede data


Nogle registre indeholder fortrolige og følsomme data, hvor adgangen er begrænset.

Adgang til adgangsbegrænsede data bliver tildelt af registrene ved at en anvender opretter et IT-system og ansøger gennem selvbetjeningen til det specifikke register på vegne af det nyoprettede IT-system, hvorefter det pågældende register først skal godkende ansøgningen før data kan tilgås. Læs mere om Brugeradgang på datafordeler.dk og hvordan et IT-system oprettes i på siden IT-systemer.




Registre med adgangsbegrænsede data


Tabellen neden for viser hvilke registre der indeholder adgangsbegrænsede data

Register

Entiteter

CVR

CVRPerson

EJF

Alle entiteter

SVR

Alle entiteter

CPR

Alle entiteter undtaget ”AdministrativEnhed” og ” AdministrativEnhedType”






Sådan henter du entitetsbaserede fildownload


Fildownload på Datafordeleren tilgås via et REST-API. Dette afsnit beskriver, hvordan det vil være muligt at danne et overblik over hvilke fildownload du kan kan hente, samt hvorledes relevante fildownload herefter hentes. REST-API'et indeholder to metoder som kan kaldes. REST-API'et kræver at du har oprettet en bruger på Datafordeleren og benytter en af de autentifikationsmetoder beskrevet under Autentifikation og autorisation for fildownload.



Ovenstående figur viser hvordan REST-API'et overordnet set anvendes. Her kaldes metoden "GetAvailableFileDownloads" først for at danne et overblik over mulige filer der er tilgængelige, hvorefter relevante filer hentes, ved at kalde metoden "GetFile".




Version for REST-API’et


Hvis du tilgår fildownload REST-API’et uden at specificere et versionsnummer, vil du automatisk blive sendt til den nyeste version af tjenesten. Dette kan medføre, at du kalder en ny version, som kan indeholde breaking changes. For at undgå dette, er det vigtigt at specificere versionsnummeret for tjenesten i url'en. Med "tjeneste" menes der her API'et, som håndterer dine forespørgsler og returnerer data.

Når du tilgår tjenesten for fildownload, kan du inkludere versionsnummeret i url'en for at sikre, at du bruger den ønskede version af tjenesten. Versionsnummeret angives som en del af stien i url'en.


Eksempel:

https://<env>-api.datafordeler.dk/FileDownloads/v{version}/<metode>?

Her angiver {version} det specifikke versionsnummer, du ønsker at bruge.

For eksempel, hvis du ønsker at bruge version 1.0 af tjenesten, vil url'en se sådan ud:

https://<env>-api.datafordeler.dk/FileDownloads/v1.0/<metode>?

Hvis der ikke angives et versionsnummer, vil url'en se sådan ud:

https://<env>-api.datafordeler.dk/FileDownloads/<metode>?

I dette tilfælde vil du automatisk blive sendt til den nyeste version af tjenesten.




Metode: GetAvailableFiledownloads


GetAvailableFileDownloads returnerer hvilke fildownloads der kan hentes. Der er 2 versioner for GetAvailableFiledownloads, hvor version 2 inkluderer kommuneopdelte fildownloads og understøtter paging. Begge versioner bliver beskrevet yderligere nedenfor.




Version 1 GetAvailableFiledownloads


Metode: GetAvailableFiledownloads


URL

https://<env>-api.datafordeler.dk/FileDownloads/v1.0/GetAvailableFileDownloads?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200 – OK, ved succes.
  • Returnerer HTTP 400 – Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404 – Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500 – Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

Tjenestebruger med brugernavn og password, API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

Valgfri

Register

String

Begrænser responsen til kun at indeholde fildownloads fra det angivne register. Følgende registre kan angives:

  • DAR
  • DAGI
  • BBR
  • DHMOprindelse
  • DHMHoejdekurver
  • MAT
  • EBR
  • FIKSPUNKT
  • DS
  • GEODKV
  • CVR
  • CPR
  • EJF
  • SVR
  • VUR

Ja

Version

String

Begrænser responsen til kun at indeholde fildownload der er i den angivne version. Parameteret kan kun angives hvis "Register" parameteret er angivet.

Version som parameter bruges til at angive hvilken version der skal bruges, hvis f.eks. datamodellen ændre sig.

Ja

Entity

String

Begrænser responsen til kun at indeholde fildownload der er af samme type som den angivne entitet. Parameteret kan kun angives hvis "Register" parameteret er angivet.

Ja


Returværdier

Metoden returnerer metadata om fildownload, der følger strukturen beskrevet i følgende tabel. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge.

Felt

Beskrivelse

Filename

Navnet på filen som kan downloades.

Register

Angiver hvilket register data i filen tilhører.

EntityName

Angiver navnet på registerentiteten som filens data tilhører.

Frequency

Angiver hvornår/hvor ofte der bliver genereret en ny fil af samme type med nyt udtræksnummer.

TypeOfDownload

Angiver om filen er et totaldownload eller et deltadownload.

TypeOfData

Angiver hvilken bitemporal filtrering der er anvendt på data i filen. Denne kan enten være "Bitemporal", "Temporal" eller "Current".

Version

Angiver underlæggende version af filens data.

GenerationNumber

Angiver udtræksnummeret.

PointInTime

Angiver tidspunkt for registrerings- og virkningstid der blev anvendt ved generering af fildownload. Feltet er kun sat hvis der er tale om et deltadownload eller et Temporalt eller Current totaldownload.

Datoformat følger ISO 8601

Tidszonen er UTC

GenerationTime

Angiver tidspunktet for hvornår filen blev genereret.

Datoformat følger ISO 8601

Tidszonen er UTC

ExpirationDate

Angiver hvornår filen ikke længere udstilles på Datafordeleren.

Datoformat følger ISO 8601

Tidszonen er UTC

ContainedFileFormat

Angiver hvilket filformat ZIP-filen indeholder.

OutputFileFormat

Angiver filformatet på selve filen som kan downloades.

Md5Hash

Angiver md5 hash på filens indhold og kan bruges til at verificere at filen. Den returnerer null for kommuneopdelte fildownloads, eftersom disse filer ikke understøttes.

FileSizeInBytes

Angiver filstørrelse på filen og kan bruges til at hurtigt at sammenligne filstørrelsen. Den er sat til at være null for kommuneopdelte fildownloads, eftersom disse filer ikke understøttes.

RegisterImportSequenceNumber

Angiver sekvensnummer for dataindlæsning ved generering af fildownload. Kan være ”null” hvis:

  • Registret ikke har moderniserede hændelser (Se mere under Registre uden hændelser) 
  • Registrets version har ikke moderniserede hændelser (Gælder kun nuværende DAGI_v1 fildownload)
  • Der er ikke blevet indlæst nye data efter udstilling af RegisterImportSequenceNumber 

MunicipalityCode

Kommuneopdelte fildownloads udstilles ikke i version 1, og værdi kommer altid at være ”null”. Se version 2, hvor kommuneopdelte fildownloads udstilles, for mere information. 


Eksempler på brug af metoden

Se tilgængelige fildownload for DAGI ved brug af tjenestebruger:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailableFileDownloads?Register=DAGI&username=xxxx&password=yyyy

Se tilgængelige fildownload for "Bygning"-entiteten ved brug API-key:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailableFileDownloads?Register=BBR&Entity=Bygning&apiKey=xxxx 

Se tilgængelige fildownload i version 1 i EBR ved brug af OAuth Shared Secret eller OAuth Certifikat (sættes i header’en):

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailableFileDownloads?Register=EBR&Version=1

BEMÆRK vedrørende fildownload med z-koordinat

Ved release af udviklingsleverance 2 fra Datafordelerens moderniseringsprojekt er fildownload opdateret med en version 2, så de kun udstiller z-koordinater, hvis et register anvender det.

Dermed har DAR, DAGI, BBR, DHMOprindelse, DHMHoejdekurver, MAT, EBR, FIKSPUNKT, DS og GEODKV fået tilføjet en version 2 af fildownload, hvor det kun er GEODKV, der anvender z-koordinater.

I version 1 for fildownload for ovenstående registre bliver z-koordinat udstillet for alle geometrier, uanset om registeret sender z-koordinater.


Eksempel fra deltadownload fra MAT Lodflade (udstiller ikke z-koordinat):

  • Version 1: "geometri": "POLYGON Z(...)"
  • Version 2: "geometri": "POLYGON (...)"




Version 2 GetAvailableFiledownloads


Metode: GetAvailableFiledownloads


URL

https://<env>-api.datafordeler.dk/FileDownloads/v2.0/GetAvailableFileDownloads?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200 – OK, ved succes.
  • Returnerer HTTP 400 – Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404 – Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500 – Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

Tjenestebruger med brugernavn og password, API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

Valgfri

Register

String

Begrænser responsen til kun at indeholde fildownloads fra det angivne register. Følgende registre kan angives:

  • DAR
  • DAGI
  • BBR
  • DHMOprindelse
  • DHMHoejdekurver
  • MAT
  • EBR
  • FIKSPUNKT
  • DS
  • GEODKV
  • CVR
  • CPR
  • EJF
  • SVR
  • VUR

Ja

Version

String

Begrænser responsen til kun at indeholde fildownload der er i den angivne version. Parameteret kan kun angives hvis "Register" parameteret er angivet.

Version som parameter bruges til at angive hvilken version der skal bruges, hvis f.eks. datamodellen ændre sig.

Ja

Entity

String

Begrænser responsen til kun at indeholde fildownload der er af samme type som den angivne entitet. Parameteret kan kun angives hvis "Register" parameteret er angivet.

Ja

PageNumber

Int

Specificerer hvilken side af resultat der skal blive vises ift. paging. Den første siden vises hvis det ikke er angivet.

Ja


Returværdier

Metoden returnerer metadata om fildownload, der følger strukturen beskrevet i følgende tabel. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge.

Felt

Beskrivelse

PaginationMetadata

CurrentPage

Angiver den nuværende side der vises.

PageSize

Angiver antal fildownloads der vises på nuværende side.

TotalCount

Angiver totale fildownloads der findes fra din query.

TotalPages

Angiver totale sider der findes fra din query.

AvailableFileDownloads

Filename

Navnet på filen som kan downloades.

Register

Angiver hvilket register data i filen tilhører.

EntityName

Angiver navnet på registerentiteten som filens data tilhører.

Frequency

Angiver hvornår/hvor ofte der bliver genereret en ny fil af samme type med nyt udtræksnummer.

TypeOfDownload

Angiver om filen er et totaldownload eller et deltadownload.

TypeOfData

Angiver hvilken bitemporal filtrering der er anvendt på data i filen. Denne kan enten være ”Bitemporal”, ”Temporal” eller ”Current”.

Version

Angiver underlæggende version af filens data.

GenerationNumber

Angiver udtræksnummeret.

PointInTime

Angiver tidspunkt for registrerings- og virkningstid der blev anvendt ved generering af fildownload. Feltet er kun sat hvis der er tale om et deltadownload eller et Temporalt eller Current totaldownload.

Datoformat følger ISO 8601

Tidszonen er UTC

GenerationTime

Angiver tidspunktet for hvornår filen blev genereret.

Datoformat følger ISO 8601

Tidszonen er UTC

ExpirationDate

Angiver hvornår filen ikke længere udstilles på Datafordeleren.

Datoformat følger ISO 8601

Tidszonen er UTC

ContainedFileFormat

Angiver hvilket filformat ZIP-filen indeholder.

OutputFileFormat

Angiver filformatet på selve filen som kan downloades.

Md5Hash

Angiver md5 hash på filens indhold og kan bruges til at verificere at filen. Den returnerer null for kommuneopdelte fildownloads, eftersom disse filer ikke understøttes.

FileSizeInBytes

Angiver filstørrelse på filen og kan bruges til at hurtigt at sammenligne filstørrelsen. Den er sat til at være null for kommuneopdelte fildownloads, eftersom disse filer ikke understøttes.

RegisterImportSequenceNumber

Angiver sekvensnummer for dataindlæsning ved generering af fildownload. Kan være ”null” hvis:

  • Registret ikke har moderniserede hændelser (Se mere under Registre uden hændelser) 
  • Registrets version har ikke moderniserede hændelser (Gælder kun nuværende DAGI_v1 fildownload)
  • Der er ikke blevet indlæst nye data efter udstilling af RegisterImportSequenceNumber 

MunicipalityCode

Den kommunekode det kommuneopdelte fildownload er genereret for, eller ”null” for ikke kommuneopdelte fildownloads.


Eksempler på brug af metoden

Se tilgængelige fildownload for alle register ved brug API-nøgle, med paging for at vise side 2:

https://api.datafordeler.dk/FileDownloads/v2.0/GetAvailableFileDownloads?PageNumber=2&apiKey=xxxx

Se tilgængelige fildownload i version 1 i EBR af OAuth Shared Secret eller OAuth Certifikat (sættes i header’en), med paging for at vise side 1:

https://api.datafordeler.dk/FileDownloads/2.0/GetAvailableFileDownloads?PageNumber=1&Register=EBR&Version=1 




Metode: GetFile


GetFile bruges for at hente fildownload. Det kan ske på forskellige måde, se nedenfor hvilke parametre der er tilgængelige og hvad der returneres. 




Metode: GetFile


URL

https://<env>-api.datafordeler.dk/FileDownloads/v{version}/GetFile?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP

Returværdier

  • Returnerer HTTP 200 – OK, ved succes.
  • Returnerer HTTP 400 – Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404 – Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til den angivne fil.
  • Returnerer HTTP 500 – Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

Ikke-adgangsbegrænset data: Tjenestebruger med brugernavn og password eller IT-system med API-key, OAuth Shared Secret eller OAuth Certifikat.

Adgangsbegrænset data: IT-system med OAuth Shared Secret eller OAuth Certifikat og på en defineret IP-Allowlist og så skal IT-systemet have eksplicit godkendelse fra det pågældende register. 

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC





Parametre

Navn

Type

Beskrivelse

Filename

String

Specificerer en specifik fil til download. Dette parameter kan kun angives alene.

Register

String

Specificerer, hvilket register der ønskes download fra. Hvis ikke parametrene 'LatestTotalForEntry' og 'Type' angives, bliver alle registerets totaldownloads downloadet.
Følgende registre kan angives:

  • DAR
  • DAGI
  • BBR
  • DHMOprindelse
  • DHMHoejdekurver
  • MAT
  • EBR
  • FIKSPUNKT
  • DS
  • GEODKV
  • CVR
  • CPR
  • EJF
  • SVR
  • VUR

LatestTotalForEntity

String

Henter det seneste totaldownload for den specificerede entitet. 'Type' parameteret skal angives, såfremt dette parameter er angivet.

Type

String

Angiver hvilken type fildownload der skal downloades for entiteten. 'LatestTotalForEntity' parameteret skal angives, såfremt dette parameter er angivet.

Format

String

Angiver hvilket filformat der ønskes. Hvis 'LatestTotalForEntity' parameteret er angivet, skal dette parameter også angives.

Version

String

Angiver hvilken version fildownloadet skal være i. Såfremt dette parameter ikke angives, vælges den nyeste version.

Version som parameter bruges til at angive hvilken version der skal bruges, hvis f.eks. datamodellen ændre sig.

MunicipalityCode

String

Hvis angivet, begrænses svaret til kun at inkludere fildownload fra den specificerede kommune. Hvis ikke angivet, inkluderes alle kommuner.

Returværdier

Denne metode returnerer altid en eller flere filer ved HTTP 200 - OK.

Eksempler på brug af metoden

Hent en specifik deltafil fra Danske Stednavne registeret:

https://api.datafordeler.dk/FileDownloads/v1.0/GetFile?Filename=DS_V1_Vej_DeltaDownload_gml_Bitemporal_2335.zip&apikey=xxxx

Kaldet returnerer en enkelt fil i en ZIP-fil.

Hent totaldownload for alle entiteter i BBR:

https://api.datafordeler.dk/FileDownloads/v1.0/GetFile?Register=BBR&apikey=xxxx

Kaldet returnerer flere filer i en samlet ZIP-fil.

Hent totaldownload med aktuelle data i GML-format for en bestemt entitet i Fikspunkt-registeret:

https://api.datafordeler.dk/FileDownloads/v1.0/GetFile?Register=FIKSPUNKT&LatestTotalForEntity=HoejdefikspunktFO&Type=Current&Format=gml&apikey=xxxx

Kaldet returnerer en enkelt fil i en ZIP-fil. 

BEMÆRK vedrørende fildownload med z-koordinat

Ved release af udviklingsleverance 2 fra Datafordelerens moderniseringsprojekt er fildownload opdateret med en version 2, så de kun udstiller z-koordinater, hvis et register anvender det.

Dermed har DAR, BBR, DHMOprindelse, DHMHoejdekurver, MAT, EBR, FIKSPUNKT, DS og GEODKV fået tilføjet en version 2 af fildownload, hvor det kun er GEODKV, der anvender z-koordinater.

Vær opmærksom på at DAGI ikke har fildownload i version 2 uden z-koordinat.

I version 1 for fildownload for ovenstående registre bliver z-koordinat udstillet for alle geometrier, uanset om registeret sender z-koordinater.


Eksempel fra deltadownload fra MAT Lodflade (udstiller ikke z-koordinat):

  • Version 1: "geometri": "POLYGON Z(...)"
  • Version 2: "geometri": "POLYGON (...)"



Nye datafordeler kolonner

Med moderniseringen af hændelser er der blevet tilføjet 3 nye kolonner til alle entiteter for næsten alle register. Disse nye kolonner er ”sys_rowid”, ”sys_rowversion” og ”sys_registerimportsequencenumber”. Disse kolonner bliver kun udstillet i nye versioner så eksisterende versioner påvirkes ikke. Undtaget Ejerfortegnelsen (EJF), hvor disse kolonner udstilles i den nuværende version 1.

Se Entitetsbaserede hændelser for mere information om moderniseringen af hændelser og for hvilke register det gælder.





Rasterbaserede fildownload


Om rasterbaserede fildownload


I dette afsnit beskrives hvordan prædefineret rasterdata udstilles via fildownload.






Filformater


Datafordeleren udstiller to formater for rasterdata via fildownload; GeoTIFF og ECW. Et rasterdatasæt kan bestå af en eller flere filer i enten GeoTIFF- eller ECW-format. Nedenfor er beskrevet hvordan Datafordeleren bearbejder de rasterdata der modtages fra registrene:

  • GeoTIFF: For de registre der leverer data i GeoTIFF-format, reorganiseres data for nogle datasæt, hvis det ikke allerede er gjort af registret, til 10x10 km GeoTIFF-tiles, der er tilpasset Det Danske Kvadratnet (DDKN).
    • Alle datasæt udstilles som den originalt er aflevereret til Datafordeleren af registrene.
    • For de datasæt der reorganiseres, udstilles de også som 10x10 tiles. Det er:
      • Overflade
      • Overflade2015
      • OverfladeSkygge
      • Terraen
      • Terraen2015
      • TerraenSkygge
    • Se en samlet liste over tilgængelige datasæt.
  • ECW: For registre, der leverer data i ECW-format, reorganiseres data ikke af Datafordeleren, og anvendere vil derfor modtage data i dets oprindelige replikerede ECW-format.

Registre distribuerer data i form af tiles i forskellige størrelser for at imødekomme forskellige behov; dimensionerne kan for eksempel være 1x1 km eller 10x10 km. For data replikeret i 1x1 km-formatet placeres det systematisk i grupper på op til 100 i henhold til den tilsvarende 10x10 km-tile for de datasæt der er nævnt ovenfor. Denne gruppering dækker derfor det samme geografiske område som en enkelt 10x10 km-tile. Anvendere kan benytte https://earthmaps.dataforsyningen.dk/dfTiles til at finde navnene på de pågældende tiles.

Ud over den tile-baserede tilgang, tilbyder Datafordeleren også muligheden for at hente én samlet GeoTIFF-fil for Skærmkortet, der dækker hele landet. Denne fil giver anvenderne et samlet overblik over al data, hvilket eliminerer behovet for individuelt at hente og administrere hver tile.




Følgende registre udstiller rasterdata på Datafordeleren:

Register

Forkortelse

Skærmkortet

skaermkort

Danmarks Højdemodel

DHM

GeoDanmark Ortofoto

GEODKO

Danmarks Topografiske Kortværk

DTK




Se komplet liste over alle registrenes datasæt med rasterdata.






Sådan henter du rasterbaserede fildownload


Rasterdata på Datafordeleren tilgås via et REST-API. Dette afsnit beskriver, hvordan rasterdata hentes. REST-API'et indeholder to metoder til at hente rasterdata. REST-API'et kræver at du først har oprettet en API-key eller benytter en af de to andre autentifikationsmetoder.

Anvendere kan enten vælge at hente én prægenereret rasterfil ad gangen med metoden "GetRasterFile", eller flere prægenererede rasterfiler på samme tid ved at kalde metoden “GetRasterMultipleFiles”.

For at se hvilke Raster filer der udstilles, kan "GetAvailableRasterFileDownloads" kaldes. For en oversigt over tilgængelige fildownload, kan "GetAvailableRasterFileDownloadsOverview" kaldes.  




Metode: GetAvailableRasterFileDownloads


Returnerer hvilke rasterbaserede fildownloads der kan hentes og information om disse.


Metode: GetAvailableRasterFileDownloads

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetAvailableRasterFileDownloads?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:    OK, ved succes.
  • Returnerer HTTP 400:    Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:    Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500:    Internal Server Error, hvis der er sket en ukendt fejl

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

MinX

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Valgfri parameter. Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • skaermkort
  • DHM
  • GeoDKO
  • DTK

DataSetName

String

Valgfri parameter. Specificerer hvilket datasæt filerne skal hentes fra. Se en samlet liste over tilgængelige datasæt.

Version

Int

Valgfri parameter. Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfrit parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteret ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Pagenumber

Int

Valgfri parameter. Specificerer hvilken side med svar der skal blive returneret.

GenerationTime

DateTime

Valgfri parameter. Tid for hvornår filen er blevet genereret.

FileFormat

String

Valgfri parameter. Filformat, enten:

  • tif
  • ecw 




Returværdier

Metoden returnerer metadata om fildownload, der følger strukturen beskrevet i tabel nedenfor. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge.

Felt

Beskrivelse

PaginationMetadata

CurrentPage

Angiver den nuværende side der vises.

PageSize

Angiver antal fildownloads der vises på nuværende side.

TotalCount

Angiver totale fildownloads der findes fra din query.

TotalPages

Angiver totale sider der findes fra din query.

AvailableFileDownloads

Filename

Navnet på filen som kan downloades.

RegisterName

Angiver hvilket register data i filen tilhører.

Version

Angiver underlæggende version af filens data.

GenerationTime

Angiver tidspunktet for hvornår filen blev genereret.

FileFormat

Angiver filformat for filen.

FileSizeInBytes

Angiver filstørrelse på filen og kan bruges til at hurtigt at sammenligne filstørrelsen.

ID

Angiver det ID der kan bruges for at identificere en fil.

DataSetName

Angiver hvilket datasæt filerne skal hentes fra. Se en samlet liste over tilgængelige datasæt.

DataDeliveryNumber

Angiver hvilken dataleverance filen er fra.

BoundingBox

Angiver bounding box for filen. Består af MinX, MaxX, MinY og MaxY.




Eksempel på brug af metoden

Se tilgængelige fildownloads for version 1:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailableRasterFileDownloads?Version=1&apiKey=xxxx




Metode: GetAvailableRasterFileDownloadsOverview


Metoden returnerer en oversigt for tilgængelige rasterbaserede fildownloads, med information om antal filer per register, datasæt osv. Denne info kan bruges for at definere parametre til GetAvailableRasterFileDownloads-metode.


Metode: GetAvailableRasterFileDownloadsOverview

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetAvailableRasterFileDownloadsOverview?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:    OK, ved succes.
  • Returnerer HTTP 400:    Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:    Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500:    Internal Server Error, hvis der er sket en ukendt fejl

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Tillader ikke nogen parametre.




Returværdier

Metoden returnerer en oversigt for tilgængelige fildownloads, der følger strukturen beskrevet i tabel nedenfor. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge. 


Felt

Beskrivelse

RegisterName

Angiver hvilket register data i filen tilhører.

Version

Angiver underlæggende version af filens data.

RecordCount

Angiver antallet filer fra det relateret registre, version, datasæt, dataleverance og filformat.

FileFormat

Angiver filformat for filen.

DataSetName

Angiver hvilket datasæt filerne skal hentes fra. Se en samlet liste over tilgængelige datasæt.

DataDeliveryNumber

Angiver hvilken dataleverance filen er fra.




Eksempel på brug af metoden

Se tilgængelige fildownloads:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailableRasterFileDownloadsOverview




Metode: GetRasterFile


I dette afsnit beskrives metoden “GetRasterFile” som returnerer én rasterfil ad gangen.


Metode: GetRasterFile

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetRasterFile

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP (der indeholder GeoTIFF eller ECW-fil)

Returværdier

  • Returnerer HTTP 200:   OK, ved succes.
  • Returnerer HTTP 400:   Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:   Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 500:   Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

FileName

String

Angiver det filnavn for den fil der skal hentes

Id

String

Angiver det ID for den fil der skal hentes




Returværdier

Denne metode returnerer altid en ZIP-fil indeholdendes en GeoTIFF eller ECW fil ved HTTP 200 - OK.




Eksempler på brug af metoden

Hent en rasterfil med filnavn, respektive id:

https://api.datafordeler.dk/FileDownloads/GetRasterFile?FileName=DSM_10km_604_68.tif&apiKey=xxxx

https://api.datafordeler.dk/FileDownloads/GetRasterFile?Id=RC00318_Overflade2015_1_DSM_10km_604_68.tif&apiKey=xxxx




Metode: GetRasterMultipleFiles


I dette afsnit beskrives metoden “GetRasterMultipleFiles” som returnerer én eller flere rasterfiler ad gangen. Metoden tager derimod to sæt af koordinater som udgør en såkaldt bounding box.

En bounding box er en rektangulær, geografisk afgrænsning, som angiver hvilke tiles der returneres til anvenderen. Bounding box’en er defineret ved koordinaterne: minX, minY, maxX og maxY, som alle skal være inden for EPSG-25832 grænserne.

Nedenfor er vist et eksempel på en bounding box for koordinaterne minX: 721148, minY: 6175495, maxX: 722618 og maxY: 6176355:





Metode: GetRasterMultipleFiles

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetRasterMultipleFiles

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP (der indeholder GeoTIFF eller ECW filer)

Returværdier

  • Returnerer HTTP 200:  OK, ved succes.
  • Returnerer HTTP 400:  Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:  Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 413:  Payload er for stort, hvis summen af størrelsen på de efterspurgte filer overstiger den predefinerede øvre grænsen.
  • Returnerer HTTP 500:  Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601
Tidszonen er UTC


Parametre

Navn

Type

Beskrivelse

MinX

String

Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • skaermkort
  • DHM
  • GeoDKO
  • DTK

DataSetName

String

Specificerer hvilket datasæt filerne skal hentes fra. Se Bilag 3 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

Version

Int

Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfri parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteren ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Returværdier

Denne metode returnerer altid en eller flere filer ved HTTP 200 - OK.

Eksempler på brug af metoden

Hent flere rasterfiler fra Danmarks Højdemodel samtidig:

https://api.datafordeler.dk/FileDownloads/GetRasterMultipleFiles?minx=650000&miny=6070000&maxx=690000&maxy=6130000&register=dhm&version=1&datasetname=overflade&apiKey=xxxx

Kaldet returnerer filen dhm_overflade_650000_6070000-690000_6130000.zip. 




Metode: GetRasterMultipleSize


Når en anvender ønsker at kende størrelsen på de prægenerede rasterfiler inden de hentes via fildownload, kan metoden GetRasterMultipleSize, som beskrives i dette afsnit, benyttes.




Metode: GetRasterMultipleSize

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetRasterMultipleSize

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:  OK, ved succes.
  • Returnerer HTTP 400:  Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:  Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 500:  Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601
Tidszonen er UTC

 

Parametre

Navn

Type

Beskrivelse

MinX

String

Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • skaermkort
  • DHM
  • GeoDKO
  • DTK

DataSetName

String

Specificerer hvilket datasæt filerne skal hentes fra. Se en samlet liste over tilgængelige datasæt.

Version

Int

Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfri parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteren ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Returværdier

Denne metode returnerer altid en tekststreng med størrelsen på ZIP-filen og den øvre grænse for størrelse på filerne i Gigabytes.

Eksempler på brug af metoden

Hent en specifik rasterfil fra Danmarks Højdemodel:

https://api.datafordeler.dk/FileDownloads/GetRasterMultipleSize?minx=650000&miny=6070000&maxx=690000&maxy=6130000®ister=dhm&version=1&datasetname=overflade&apiKey=placeholderNoegle

Kaldet returnerer tekststrengen “39.2 GB / 45.0 GB”.




Skærmkort fildownload


Hvis man har brug for at hente Skærmkort rasterdata i alle zoomniveauer (f.eks. 1x1, 5x5 og 10x10 km) kan endepunkter for Skærmkort kaldes. Dette eliminerer behovet for at hente og administrere hver tile individuelt, ved at kalde GetRasterMultipleFiles for hvert zoomniveau. Enten kan alt Skærmkort data hentes, ved at kalde GetAllSkaermkortFiles, eller en bounding box kan angives som parameter ved at kalde GetSkaermkortFiles.

Læs mere om bounding box i afsnittet Metode: GetRasterMultipleFiles.




Metode: GetSkaermkortFiles 


Når du som anvender ønsker at hente Skærmkort data indenfor en bounding box, kan GetSkaermkortFiles benyttes.


Metode: GetSkaermkortFiles

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetSkaermkortFiles

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP (der indeholder GeoTIFF filer)

Returværdier

  • Returnerer HTTP 200:   OK, ved succes.
  • Returnerer HTTP 400:   Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:   Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 413:   Payload er for stort, hvis summen af størrelsen på de efterspurgte filer overstiger den predefinerede øvre grænsen.
  • Returnerer HTTP 500:   Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

MinX

String

Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

DataSet

String

Specificerer hvilket datasæt filerne skal hentes fra. Se en samlet liste over tilgængelige datasæt.

Version

Int

Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfrit parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteret ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.




Returværdier

Denne metode returnerer altid en ZIP-fil, med en eller flere GEoTIFF filer i, ved HTTP 200 - OK.




Eksempel på brug af metoden

Hent Skærmkort data der er indenfor bounding box:

https://api.datafordeler.dk/FileDownloads/GetSkaermkortFiles?minX=500000&minY=6150000&maxX=550000&maxY=6200000&version=1&datasetname=daempet

Kaldet returnerer filen SKAERMKORT_daempet_500000_6150000-550000_6200000.zip.




Metode: GetAllSkaermkortFiles


Når du som anvender ønsker at hente alt Skærmkort data, der dækker hele landet, kan GetAllSkaermkortFiles benyttes.


Metode: GetAllSkaermkortFiles

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetAllSkaermkortFiles

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP (der indeholder GeoTIFF filer)

Returværdier

  • Returnerer HTTP 200:   OK, ved succes.
  • Returnerer HTTP 400:   Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:   Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 413:   Payload er for stort, hvis summen af størrelsen på de efterspurgte filer overstiger den predefinerede øvre grænsen.
  • Returnerer HTTP 500:   Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

Version

String

Angiver hvilken version der skal hentes skærmkort data for. Der er pt. kun version ”1” der udstilles.

DataDeliveryNumber

Int

Valgfrit parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteret ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.




Returværdier

Denne metode returnerer altid en ZIP-fil, med flere GeoTIFF filer i, ved HTTP 200 - OK.




Eksempel på brug af metoden

Hent all Skærmkort data for version 1:

https://api.datafordeler.dk/FileDownloads/GetAllSkaermkortFiles?version=1

Kaldet returnerer filen SKAERMKORT.zip.





Punktskybaserede fildownload


Om punktskybaserede fildownload


Punktskydata tilbydes via Datafordeleren, som prædefinerede filer og udstilles via fildownload.






Filformater


Datafordeleren udstiller to formater for punktskydata via fildownload: LAZ- og LAS-format. 

Det eneste register der udstiller punktskydata på Datafordeleren er Danmarks Højdemodel (DHM).

En komplet liste over DHMs datasæt med punktskydata kan findes i Bilag 4 på Transitionsguide (fildownload).






Sådan henter du punktskydata via fildownload


Punktskydata på Datafordeleren tilgås via et REST-API. Dette afsnit beskriver, hvordan punktskydata hentes. REST-API'et indeholder to metoder til at hente punktskydata som kan kaldes. REST-API'et kræver at du først har oprettet en API-key eller benytter en af de to andre autentifikationsmetoder.

Anvendere kan enten vælge at hente én prægenereret punktskyfil ad gangen eller flere prægenererede punktskyfiler på samme tid ved at kalde metoden “GetPointCloudMultipleFiles”. For at se hvilke punktsky filer der udstilles, kan GetAvailablePointCloudFileDownloads kaldes.

For en oversigt over tilgængelige fildownload, kan GetAvailablePointCloudFileDownloadsOverview kaldes. 




Metode: GetAvailablePointCloudFileDownloads


Returnerer hvilke punktskybaserede fildownloads der kan hentes og information om disse.


Metode: GetAvailableRasterFileDownloads

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetAvailablePointCloudFileDownloads?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:    OK, ved succes.
  • Returnerer HTTP 400:    Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:    Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500:    Internal Server Error, hvis der er sket en ukendt fejl

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

MinX

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Valgfri parameter, men alle koordinater skal angives hvis brugt. Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Valgfri parameter. Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • DHM

DataSetName

String

Valgfri parameter. Specificerer hvilket datasæt filerne skal hentes fra. Se Bilag 4 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

Version

Int

Valgfri parameter. Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfrit parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteret ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Pagenumber

Int

Valgfri parameter. Specificerer hvilken side med svar der skal blive returneret.

GenerationTime

DateTime

Valgfri parameter. Tid for hvornår filen er blevet genereret.

FileFormat

String

Valgfri parameter. Filformat, enten:

  • tif
  • ecw 




Returværdier

Metoden returnerer metadata om fildownload, der følger strukturen beskrevet i tabel nedenfor. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge.

Felt

Beskrivelse

PaginationMetadata

CurrentPage

Angiver den nuværende side der vises.

PageSize

Angiver antal fildownloads der vises på nuværende side.

TotalCount

Angiver totale fildownloads der findes fra din query.

TotalPages

Angiver totale sider der findes fra din query.

AvailableFileDownloads

Filename

Navnet på filen som kan downloades.

RegisterName

Angiver hvilket register data i filen tilhører.

Version

Angiver underlæggende version af filens data.

GenerationTime

Angiver tidspunktet for hvornår filen blev genereret.

FileFormat

Angiver filformat for filen.

FileSizeInBytes

Angiver filstørrelse på filen og kan bruges til at hurtigt at sammenligne filstørrelsen.

ID

Angiver det ID der kan bruges for at identificere en fil.

DataSetName

Angiver hvilket datasæt filerne skal hentes fra. Se Bilag 4 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

DataDeliveryNumber

Angiver hvilken dataleverance filen er fra.

BoundingBox

Angiver bounding box for filen. Består af MinX, MaxX, MinY og MaxY.




Eksempel på brug af metoden

Se tilgængelige fildownloads for version 1:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailablePointCloudFileDownloads?Version=1&apiKey=xxxx




Metode: GetAvailablePointCloudFileDownloadsOverview


Metoden returnerer en oversigt for tilgængelige punktskybaserede fildownload, med information om antal filer per register, datasæt osv. Denne info kan bruges for at definere parametre til GetAvailablePointCloudFileDownloads-metode.


Metode: GetAvailablePointCloudFileDownloadsOverview

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetAvailablePointCloudFileDownloadsOverview?

HTTP-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:    OK, ved succes.
  • Returnerer HTTP 400:    Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:    Not Found, hvis den angivne ressource ikke kan findes.
  • Returnerer HTTP 500:    Internal Server Error, hvis der er sket en ukendt fejl

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601

Tidszonen er UTC




Parametre

Tillader ikke nogen parametre.




Returværdier

Metoden returnerer en oversigt for til tilgængelige fildownload, der følger strukturen beskrevet i tabel nedenfor. Der er ikke nogen sortering defineret, så resultater optræder i tilfældig rækkefølge.

Felt

Beskrivelse

RegisterName

Angiver hvilket register data i filen tilhører.

Version

Angiver underlæggende version af filens data.

RecordCount

Angiver antallet filer fra det relateret registre, version, datasæt, dataleverance og filformat.

FileFormat

Angiver filformat for filen.

DataSetName

Angiver hvilket datasæt filerne skal hentes fra. Se Bilag 4 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

DataDeliveryNumber

Angiver hvilken dataleverance filen er fra.




Eksempler på brug af metoden

Se tilgængelige fildownloads:

https://api.datafordeler.dk/FileDownloads/v1.0/GetAvailablePointCloudFileDownloadsOverview?Version=1&apiKey=xxxx




Metode: GetPointCloudFile


I dette afsnit beskrives metoden “GetPointCloudFile” som returnerer én punktskyfil ad gangen.


Metode: GetPointCloudFile

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetPointCloudFile

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

ZIP (der indeholder LAS eller LAZ filer)

Returværdier

  • Returnerer HTTP 200:   OK, ved succes.
  • Returnerer HTTP 400:   Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:   Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 500:   Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601
Tidszonen er UTC




Parametre

Navn

Type

Beskrivelse

FileName

String

Angiver det filnavn for den fil der skal hentes

Id

String

Angiver det ID for den fil der skal hentes




Returværdier

Denne metode returnerer altid en ZIP der indeholder en LAS eller LAZ fil ved HTTP 200 - OK.




Eksempler på brug af metoden

Hent en punktskyfil med filnavn, respektive id:

https://api.datafordeler.dk/FileDownloads/GetPointCloudFile?FileName=punktsky_1km_6049_684.las&apiKey=xxxx

https://api.datafordeler.dk/FileDownloads/GetPointCloudFile?Id=RC00267_Punktsky2007_1_punktsky_1km_6049_684.las&apiKey=xxxx




Metode: GetPointCloudMultipleFiles


I dette afsnit beskrives metoden “GetPointCloudMultipleFiles” som kan returnere én eller flere punktskyfiler ad gangen. Ligesom “GetRasterMultipleFiles” tager ”GetPointCloudMultipleFiles” også en bounding box som parameter. Læs mere om bounding box.




Metode: GetPointCloudMultipleFiles

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetPointCloudMultipleFiles

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:  OK, ved succes.
  • Returnerer HTTP 400:  Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:  Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 413:  Payload er for stort, hvis summen af størrelsen på de efterspurgte filer overstiger den predefinerede øvre grænsen.
  • Returnerer HTTP 500:  Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601
Tidszonen er UTC

Parametre

Navn

Type

Beskrivelse

MinX

String

Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • DHM

DataSetName

String

Specificerer hvilket datasæt filerne skal hentes fra. Se Bilag 4 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

Version

Int

Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfri parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteren ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Returværdier

Denne metode returnerer altid 1 ZIP, med en eller flere filer i, ved HTTP 200 - OK.

Eksempler på brug af metoden

Hent flere punktskyfiler fra Danmarks Højdemodel:

https://api.datafordeler.dk/FileDownloads/GetPointCloudMultipleFiles?minx=710000&miny=6070000&maxx=750000&maxy=6190000&register=dhm&version=1&datasetname=punktsky2015&apiKey=placeholderNoegle

Kaldet returnerer filen dhm_overflade_710000_6070000-750000_6190000.zip.




Metode: GetPointCloudMultipleSize


Når en anvender ønsker at kende størrelsen på de prægenerede rasterfiler inden de hentes via fildownload, kan metoden GetPointCloudMultipleSize, som beskrives i dette afsnit, benyttes.




Metode: GetPointCloudMultipleSize

URL

https://<env>-api.datafordeler.dk/FileDownloads/GetPointCloudMultipleSize

http-metode

GET

Headere i forespørgsel

Content-Type: application/json

Format

JSON

Returværdier

  • Returnerer HTTP 200:  OK, ved succes.
  • Returnerer HTTP 400:  Bad Request, ved angivelse af forkerte parametre.
  • Returnerer HTTP 404:  Not Found, hvis den angivne ressource ikke kan findes eller hvis brugeren ikke har adgang til de pågældende filer.
  • Returnerer HTTP 500:  Internal Server Error, hvis der er sket en ukendt fejl.

Adgang

API-key, OAuth Shared Secret eller OAuth Certifikat.

Dato- og tidsformat

Datoformat følger ISO 8601
Tidszonen er UTC

Parametre

Navn

Type

Beskrivelse

MinX

String

Angiver X-koordinatet for det nederste venstre hjørne af bounding box’en

MinY

String

Angiver Y-koordinatet for det nederste venstre hjørne af bounding box’en

MaxX

String

Angiver X-koordinatet for det øverste højre hjørne af bounding box’en

MaxY

String

Angiver Y-koordinatet for det øverste højre hjørne af bounding box’en

Register

String

Specificerer hvilket register filerne skal hentes fra.

Følgende registre kan angives:

  • DHM

DataSetName

String

Specificerer hvilket datasæt filerne skal hentes fra. Se Bilag 4 på Transitionsguide (fildownload) for en samlet liste over tilgængelige datasæt.

Version

Int

Specificerer hvilken datamodelversion filerne skal hentes fra.

DataDeliveryNumber

Int

Valgfri parameter. Angiver hvilken dataleverance filerne skal hentes fra. Hvis parameteren ikke angives, hentes filerne fra den nyeste dataleverance givet resten af parametrene.

Returværdier

Denne metode returnerer altid en tekststreng med størrelsen på ZIP-filen og den øvre grænse for størrelse på filerne i Gigabytes.

Eksempler på brug af metoden

Hent flere punktskyfiler fra Danmarks Højdemodel samtidig:

https://api.datafordeler.dk/FileDownloads/GetPointCloudMultipleSize?minx=710000&miny=6070000&maxx=750000&maxy=6190000&register=dhm&version=1&datasetname=punktsky2015&apiKey=placeholderNoegle

Kaldet returnerer tekststrengen “24.9 GB / 45.0 GB”.





Autentifikation og autorisation for fildownload


Når du ønsker at benytte fildownload kræver det at du er autentificeret. Datafordeleren har en række forskellige autentifikationsmetoder, som du kan vælge at benytte afhængigt af om du forsøger at tilgå frit tilgængeligt eller adgangsbegrænset data:

  • IT-system med API-key: En API-key er en privat nøgle, som bruges til at autentificere mod et API. Denne nøgle bruges som en del af godkendelsesprocessen, hvor en klient får adgang til et API uden at afsløre brugerens loginoplysninger. API-keys bruges som et query-parameter. 
  • IT-system med OAuth Shared Secret: En OAuth Shared Secret er en privat nøgle, som deles mellem en klient (f.eks. en applikation) og udbyderen (f.eks. en service som Datafordeleren). Denne nøgle bruges som en del af godkendelsesprocessen, hvor en klient får adgang til ressourcer på vegne af en bruger uden at afsløre brugerens loginoplysninger. For at blive autentificeret ved hjælp af OAuth Shared Secret skal du som anvender først oprette en Shared Secret i Datafordeler Administration. Når du har oprettet en Shared Secret sendes denne samt Client ID til https://auth.datafordeler.dk/realms/distribution/protocol/openid-connect/token ​hvorefter man vil modtage et Access Token. En mere detaljeret beskrivelse af hvordan man får et token kan findes på https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret. Det resulterende token er et Bearer Token der kan bruges til autentifikation ved efterfølgende kald til datafordeleren. Bemærk at dette token kun er validt i 60 minutter efter udstedelsen.
  • IT-system med OAuth Certifikat: Klientautentificering med certifikater i OAuth er en sikkerhedsmetode, hvor en klient (f.eks. en applikation) bruger et digitalt certifikat i stedet for en hemmelig nøgle til at bevise sin identitet over for autorisationsserveren. Processen involverer, at klienten præsenterer sit certifikat under TLS-håndtrykket, hvorefter autorisationsserveren validerer det. Denne metode er særligt velegnet til miljøer med høje sikkerhedskrav eller ved håndtering af følsomme data. 
  • Tjenestebruger med brugernavn og adgangskode. Brugernavn og password bruges som et query-parameter. Læs mere på Tjenestebruger - brugernavn/adgangskode.

Adgang til fildownload via autentifikationsmetode API-key, Shared Secret og Certifikat, som beskrevet ovenfor kræver yderligere at IP-adressen for klienten der prøver at hente data ved brug af et IT-system er på IP-Allowlisten for det pågældende IT-system. IP-Allowlisten bruges til at verificere at klienten er autoriseret til at hente det efterspurgte data. For ikke-adgangsbegrænset data er det ikke nødvendigt at specificere en IP-Allowliste, men hvis IP-Allowlisten er specificeret skal klientens IP-adresse komme fra en af de angivne adresse på listen. Læs mere om IP-Allowlister på siden IP-allowlist.

Bemærk

Der er kun muligt at anvende tjenestebruger med brugernavn/adgangskode til at tilgå den fildownload-funktionalitet, som var tilgængelig som en del af UL1.

For at tilgå rasterdata, punktskydata, samt fildownload for registre tilføjet i UL2, kan tjenestebrugeradgang ikke anvendes.




Se nedenstående tabel for en oversigt over hvilke autentifikationsmetoder kan anvendes til at tilgå hvilke registerdata.

Datatyper

Register

Tilgængelig med autentifikationsmetode:

Tjenestebruger

API-key

OAuth (Shared Secret og Certifikat)

Rasterdata

Alle registre

 

x

x

Punktskydata

Alle registre

 

x

x

Entitetsbaserede fildownload

 

 

 

 

 

 

 

 

 

 

 

 

 

 

BBR

x

x

x

DAGI

x

x

x

DAR

x

x

x

DHMHoejdekurver

x

x

x

DHMOprindelse

x

x

x

DS

x

x

x

EBR

x

x

x

FIKSPUNKT

x

x

x

GEODKV

x

x

x

HISTKORT

x

x

x

MAT

x

x

x

VUR

 

x

x

CVR

 

x (kun ikke-beskyttet data)

x

CPR


x (kun ikke-beskyttet data)

x

EJF

 

 

x

SVR

 

 

x