link til Swagger UI dokumentation
Beskrivelse af GEUS' webtjenester til brug for HIP portalen
HIP2 funktioner 2023-11-17
Funktionskald
Der er defineret følgende funktionskald
findByBoundingbox
Returnerer pejlestatistik for alle boringer med pejlestatistik indenfor en geografisk bounding box.
Argumenter: bounding box (xmin,xmax,ymin,ymax)
Svar: Et antal boringer med stamdata (boreholeid, boreholeno, zdvr90, xutm32euref89 og yutm32euref89) og op til 17 sæt pejlestatistik
Eksempel på kald: https://data.geus.dk/hip2/findByBoundingbox/478144/721856/6028392/6421608
Eksempel på svar:
[{"boreholeid":754,"boreholeno":"3.97","zdvr90":12.5,"xutm32euref89":573038,"yutm32euref89":6382192,"statistics":{"all":{"noWL":23,"avgWLgrsu":0.01,"minWLgrsu":-0.4,"maxWLgrsu":0.8,"stdDev":0.3,"p1":-0.4,"p5":-0.39,"p10":-0.3,"p25":-0.2,"p50":0,"p75":0.15,"p90":0.36,"p95":0.58,"p99":0.76},"april":{"noWL":6,"avgWLgrsu":0.07,"minWLgrsu":-0.1,"maxWLgrsu":0.2,"stdDev":0.12,"p1":-0.1,"p5":-0.08,"p10":-0.05,"p25":0,"p50":0.05,"p75":0.18,"p90":0.2,"p95":0.2,"p99":0.2},"october":{"noWL":6,"avgWLgrsu":-0.08,"minWLgrsu":-0.4,"maxWLgrsu":0.2,"stdDev":0.23,"p1":-0.4,"p5":-0.38,"p10":-0.35,"p25":-0.25,"p50":-0.05,"p75":0.08,"p90":0.15,"p95":0.18,"p99":0.2},"july":{"noWL":5,"avgWLgrsu":0.32,"minWLgrsu":-0.2,"maxWLgrsu":0.8,"stdDev":0.41,"p1":-0.19,"p5":-0.16,"p10":-0.12,"p25":0,"p50":0.4,"p75":0.6,"p90":0.72,"p95":0.76,"p99":0.79},"january":{"noWL":6,"avgWLgrsu":-0.2,"minWLgrsu":-0.4,"maxWLgrsu":0,"stdDev":0.14,"p1":-0.4,"p5":-0.38,"p10":-0.35,"p25":-0.28,"p50":-0.2,"p75":-0.13,"p90":-0.05,"p95":-0.03,"p99":-0.01},"autumn":{"noWL":6,"avgWLgrsu":-0.08,"minWLgrsu":-0.4,"maxWLgrsu":0.2,"stdDev":0.23,"p1":-0.4,"p5":-0.38,"p10":-0.35,"p25":-0.25,"p50":-0.05,"p75":0.08,"p90":0.15,"p95":0.18,"p99":0.2},"winter":{"noWL":6,"avgWLgrsu":-0.2,"minWLgrsu":-0.4,"maxWLgrsu":0,"stdDev":0.14,"p1":-0.4,"p5":-0.38,"p10":-0.35,"p25":-0.28,"p50":-0.2,"p75":-0.13,"p90":-0.05,"p95":-0.03,"p99":-0.01},"summer":{"noWL":5,"avgWLgrsu":0.32,"minWLgrsu":-0.2,"maxWLgrsu":0.8,"stdDev":0.41,"p1":-0.19,"p5":-0.16,"p10":-0.12,"p25":0,"p50":0.4,"p75":0.6,"p90":0.72,"p95":0.76,"p99":0.79},"spring":{"noWL":6,"avgWLgrsu":0.07,"minWLgrsu":-0.1,"maxWLgrsu":0.2,"stdDev":0.12,"p1":-0.1,"p5":-0.08,"p10":-0.05,"p25":0,"p50":0.05,"p75":0.18,"p90":0.2,"p95":0.2,"p99":0.2}}}]
findByBoundingBoxLatest
Returnerer nyeste pejleværdi for alle boringer med pejlinger nyere end given dato inden for en geografisk bounding box.
Argumenter: bounding box (xmin,xmax,ymin,ymax) samt minimumsdato for pejlinger
Svar: Et antal boringer med stamdata (boreholeid, boreholeno, zdvr90, xutm32euref89, yutm32euref89) samt watlevgrsu og timeofmeas for nyeste pejling.
Øvrigt: tidspunkter angives og returneres som UTC timestamps
Eksempel på kald: https://data.geus.dk/hip2/findByBoundingboxLatest/665739/725336/6128026/6178048/2022-10-15T00:00:00.000Z
Eksempel på svar:
[{"boreholeid":224201,"boreholeno":"16.798","zdvr90":13,"xutm32euref89":557871,"yutm32euref89":6337850,"watlevgrsu":3.18,"timeofmeas":"2023-06-29T22:03:35"},{"boreholeid":737078,"boreholeno":"6.1238","zdvr90":32.69,"xutm32euref89":565982,"yutm32euref89":6370438,"watlevgrsu":2.44,"timeofmeas":"2023-02-09T00:00:00"}]
findByBoundingboxPeriodNoStats
Returnerer alle terrænnære boringer indenfor en geografisk bounding box der har pejlinger i den angivne tidsperiode
Argumenter: bounding box (xmin,xmax,ymin,ymax), år, sæson, måned, dag. De fire sidste argumenter kan hver især gives værdien -1 hvilket betyder "ingen værdi sat".
Hvis dag er angivet forventes det at måned og år også er angivet og der boringer med pejlinger på den givne dag
Hvis måned er angivet forventes det at år også er angivet og der returneres boringer med pejlinger i den givne måned
Hvis sæson er angivet forventes det at år også er angivet og der returneres boringer med pejlinger i den givne sæson
Hvis kun år er angivet returnes boringer med pejlinger i det givne år
Svar: Et antal boringer med stamdata (boreholeid, boreholeno, zdvr90, xutm32euref89, yutm32euref89) samt antallet og den gennemsnitlige vandstand for alle pejlinger indenfor tidsperioden
Eksempel på kald: https://data.geus.dk/hip2/findByBoundingboxPeriodNoStats/293005/906995/6026549/6423451/2020/-1/4/29
Eksempel på svar:
[{"boreholeid":141949,"boreholeno":"165.334","zdvr90":47.63,"xutm32euref89":610172,"yutm32euref89":6110112,"noWL":1,"watlevgrsu":1.82},{"boreholeid":141950,"boreholeno":"165.335","zdvr90":42.04,"xutm32euref89":610887,"yutm32euref89":6110064,"noWL":1,"watlevgrsu":2.06}]
findByBoundingboxPeriodStats
Returnerer pejlestatistik for alle boringer indenfor en geografisk bounding box der BÅDE har pejlinger OG pejlestatistik i den angivne tidsperiode
Argumenter: bounding box (xmin,xmax,ymin,ymax), år, sæson, måned, dag. De fire sidste argumenter kan hver især gives værdien -1 hvilket betyder "ingen værdi sat".
Hvis dag er angivet forventes det at måned og år også er angivet og der returneres totalstatistik for alle boringer med pejlinger på den givne dag
Hvis måned er angivet forventes det at år også er angivet og der returneres månedsstatisk for alle boringer med pejlinger i den givne måned
Hvis sæson er angivet forventes det at år også er angivet og der returneres sæsonstatistik for alle boringer med pejlinger i den givne sæson
Hvis kun år er angivet returnes totalstatistik for alle boringer med pejlinger i det givne år
Svar: Et antal boringer med stamdata (boreholeid, boreholeno, zdvr90, xutm32euref89, yutm32euref89) samt et pejlestatistik for den aktuelle periode (måned,sæson,total)
Eksempel på kald: https://data.geus.dk/hip2/findByBoundingboxPeriodStats/293005/906995/6026549/6423451/2020/-1/4/29
Eksempel på svar:
[{"boreholeid":142021,"boreholeno":"166.18B","zdvr90":11.3,"xutm32euref89":487769,"yutm32euref89":6088484,"noWL":4,"watlevgrsu":2.63,"statistics":{"avgWLgrsu":2.82,"minWLgrsu":0,"maxWLgrsu":5.02,"stDev":0.96,"p1":1.34,"p5":1.43,"p10":1.52,"p25":1.83,"p50":2.95,"p75":3.67,"p90":3.88,"p95":4.09,"p99":4.92}}]
findByBoreholeId
Returnerer alle pejlinger for en given boring
Argumenter: boringsid, step, minimumsdato og maximumsdato. Step angiver om listen af returnerede pejlinger skal udtyndes så der kun returneres én gennemsnitlig grundvandsdybde per step tidsenhed. Step kan være HOUR, DAY, MONTH, SEASON eller YEAR. Hvis man have alle pejlinger sættes step til -1. Minimumsdato og Maximumsdato angiver den periode hvorfra der skal returneres pejlinger. Hvis perioden ikke skal begrænses kan disse sættes til -1
Svar: Stamdata for boring (boreholeid, boreholeno, zdvr90, xutm32euref89, yutm32euref89, drilstdate, abandondat, dataowner, elevametho, locatmetho, ctrpprecis
Alle eksisterende sæt pejlestatistik for boringen
Stamdata for hvert indtag: (stringno, intakeno, intake_top, intake_bottom)
En liste af pejlinger for hvert indtag (timeofmeas, watlevgrsu)
Hvis step er -1 returneres også watlevmsl, watlevelno, method, qualitycontrol, dataowner, extremes og situation ellers returneres antallet af pejlinger indenfor step tidsintervallet (noWL) og timeofmeas vil i det tilfælde være sat til begyndelsen af step tidsintervallet.
Øvrigt: tidspunkter angives og returneres som UTC timestamps, undtagen step intervalstart for DAY,MONTH,SEASON og YEAR som er dansk tid
Eksempel på kald: https://data.geus.dk/hip2/findByBoreholeId/176216/-1/2005-01-01T00:00:00.000Z/2020-12-31T00:00:00.000Z
Eksempel på svar:
{"borehole":{"boreholeno":"34.1745","boreholeid":23886,"zdvr90":15.78,"elevametho":"Differential Global Positioning System","xutm32euref89":551899,"yutm32euref89":6318041,"locatmetho":"Differential Global Positioning System","ctrpprecis":0.006
,"statistics":{"all":{"noWL":4238,"avgWLgrsu":10,"minWLgrsu":9.63,"maxWLgrsu":11.35,"stdDev":0.18,"p1":9.66,"p5":9.69,"p10":9.75,"p25":9.86,"p50":10.01,"p75":10.16,"p90":10.18,"p95":10.18,"p99":10.2},"august":{"noWL":741,"avgWLgrsu":10.19,"minWLgrsu":10.16,"maxWLgrsu":11.35,"stdDev":0.1,"p1":10.16,"p5":10.16,"p10":10.17,"p25":10.17,"p50":10.18,"p75":10.18,"p90":10.19,"p95":10.19,"p99":10.76}}
,"intakes":[{"intakeno":1,"stringno":1,"top":9,"bottom":17,"watlevels":[{"watlevelno":1,"timeofmeas":"1988-12-05T00:00:00","watlevgrsu":10.42,"watlevelmsl":5.36,"dataowner":"GEUS"},{"watlevelno":27,"timeofmeas":"1989-03-08T00:00:00","watlevgrsu":10.67,"watlevelmsl":5.11,"method":"nedstik (el-pejleapparat)","situation":"I ro","dataowner":"GEUS"}]}]}}
getWatlevelsCSVPolygon
Returnerer alle pejlinger indenfor angivet polygon i CSV format
Argumenter: omkransende polygon i WKT format
Svar: CSV data med følgende kolonner BOREHOLEID,BOREHOLENO,INTAKEID,INTAKENO,WATLEVELID,WATLEVELNO,TIMEOFMEAS,WATLEVGRSU,WATLEVMSL,METHOD,EXTREMES,SITUATION,DATAOWNER,QUALITYCONTROL
Øvrigt: CSV data returneres i UTF-8 format. Tidspunkter er dansk tid.
Eksempel på kald: https://data.geus.dk/hip2/getWatlevelsCSVPolygon/POLYGON((706713.3225941262%206187494.382217108,707131.4551092369%206181431.827586876,702950.3851503892%206183522.3625663,702323.2182767555%206189166.7926561795,706713.3225941262%206187494.382217108))
Eksempel på svar:
"BOREHOLEID","BOREHOLENO","INTAKEID","INTAKENO","WATLEVELID","WATLEVELNO","TIMEOFMEAS","WATLEVGRSU","WATLEVMSL","METHOD","EXTREMES","SITUATION","DATAOWNER","QUALITYCONTROL"
391138,"200.5244",1,1,613230,1,2004-11-24 00:00:00.0,7.07,8.64,,,"I ro",,"GEUS",
getWatlevelsCSVkommune
Returnerer alle pejlinger indenfor angivet kommune
Argumenter: trecifret kommunekode
Svar: Som for getWatlevelsCSVPolygon
Eksempel på kald: https://data.geus.dk/hip2/getWatlevelsCSVKommune/201
Eksempel på svar: Som for getWatlevelsCSVPolygon
getWatlevelsCSVvandloebsopland
Returnerer alle pejlinger indenfor angivet vandløbsopland. Listen med id'er og geometrisk udstrækning for vandløbsoplande er tidligere leveret som et statisk datasæt fra SDFI.
Argumenter: Id for vandløbsopland
Svar: Som for getWatlevelsCSVPolygon
Eksempel på kald: https://data.geus.dk/hip2/getWatlevelsCSVVandloebsopland/5110
Eksempel på svar: Som for getWatlevelsCSVPolygon
Da de tre CSV downloadfunktioner potentielt returnerer meget store datamængder (millioner af rækker) så bør de bruges med forsigtighed.
Stamdata
Stamdata for en boring består af følgende felter:
boreholeid Id for boringen i Jupiter (heltal)
boreholeno DGU-nummer for boringen. Når boringer indberettes, får de tildelt et DGUnr. Boringer på land følger en standard, hvor karaktererne før punktummet viser, hvilket atlasblad boringen ligger på. Karaktererne efter punktummet viser et løbenummer, som kan fylde op til 5 karakterer. (text)
xutm32euref89 Boringens X-ordinat omregnet til UTM-zone 32 og datum EUREF89 (kommatal)
yutm32euref89 Boringens Y-ordinat omregnet til UTM-zone 32 og datum EUREF89 (kommatal)
zdvr90 Beregnet felt, som angiver boringens terrænkote ved højdedatum DVR90. Hvis indmålingsmetoden er Differentiel GPS (P) eller Nivelleret (N) omregnes altid til DVR90. Hvis indemålingsmetoden er en af de øvrige (mindre præcise metoder) overføres DNN koten uomregnet til DVR90 med tilhørende antal decimaler. Hvis metoden er ukendt og koten har følgende decimaler X,0 X2,5 og X7,5 overføres DNN koten uomregnet til DVR90 med tilhørende antal decimaler. Hvis metoden er ukendt og koten har andre end ovenstående decimaler omregnes til DVR90 (kommatal)
abandondat Sløjfedato er den dag, en boring er blevet lukket. For ikke sløjfede boringer vil værdien være null (tidsstempel)
ctrpprecis Usikkerheden af boringsfikspunktets koordinater. (kommmatal)
dataowner Dataejer har ret (og i visse tilfælde pligt) til at vedligeholde oplysningerne. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=867 (text)
drilstdate Startdato er den dag, hvor boringen er påbegyndt. Oplysningen kommer fra brøndboreren (dato)
elevametho Kotemetode er en beskrivelse af hvordan koten er fundet og dermed nøjagtigheden af den. Det kan bla. være en nivelleret kote eller målt med GPS etc. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=69 (text)
locatmetho Det angives, hvordan koordinaten er fundet, om den er målt med GPS eller udfra KMS kort eller andet. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=64 (text)
Stamdata for et indtag består af følgende felter:
intakeno Indtagsnummeret er en eksternt kendt, éntydig identifikation af et INDTAG i en BORING. (heltal)
screentop Dybden til toppen af filteret i meter under terræn (kommatal)
screenbottom Dybden til bunden af filteret i meter under terræn (kommatal)
stringno Stammenr. er en eksternt kendt, éntydig identifikation af en STAMME i en BORING (heltal)
top En vurdering af toppen af indtaget i meter under terræn. Beregningen er således: Brug først toppen af øverste filter i boringen. Hvis det ikke er registreret, så brug bund af forerør. Ellers brug boringsdybde minus 2 meter (2 meter er en approksimation af filterstørrelsen).
bottom Bunden af det dybestliggende filter i indtaget målt meter under terrræn
Stamdata for en pejling består af følgende felter:
watlevelno Et løbenummer for PEJLINGERNE for den given BORING (heltal)
timeofmeas Det tidspunkt, hvor pejlingen er foretaget (tidsstempel)
watlevgrsu Det målte vandspejl beregnet som meter under terrænoverfladen (kommatal)
watlevmsl Det målte vandspejl beregnet som meter over havniveau (online DVR90 ved download det valgt kotesystem) (kommatal)
dataowner Dataejer. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=867 (text)
extremes Pejleekstremer. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=731 (text)
method Metoden, der er benyttet til måling af vandstanden ved en pejling. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=93 (text)
qualitycontrol Et kvalitetsmærke, der er estimeret af GEUS med maskinlæring for at udvælge de terrænnære pejlinger, der kan bruges til hydrologisk modellering med DK-model HIP. Hvis det er en værdi i dette felt så betyder det at pejlingen er fravalgt til modellering af HIP-modelberegninger. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=2153 (heltal)
situation Vandspejlssituationen viser om pejlingen er foretaget mens vandspejlet har været i ro, under pumpning eller tilbagepejling. Pumpningen kan være foretaget i samme boring eller i en nærliggende boring. De mulige værdier findes i denne kodeliste https://data.geus.dk/tabellerkoder/koder.html?codetype=732 (text)
For boringer og indtag returneres felter uden kendt værdi og de har så værdien null. For pejlinger udelades felter uden kendt værdi helt fra funktionssvaret.
Pejlestatistik
Pejlestatistik består af følgende værdier:
avgWLgrsu den gennemsnitlige grundvandsdybde under terræn
maxWLgrsu den største grundvandsdybde under terræn
minWLgrsu den mindste grundvandsdybde under terræn
noWL antallet af pejlinger der ligger til grund for statistikken
p1 1. percentil for grundvandsdybden (interpoleret)
p5 5. percentil for grundvandsdybden (interpoleret)
p10 10. percentil for grundvandsdybden (interpoleret)
p25 25. percentil for grundvandsdybden (interpoleret)
p50 medianen for grundvandsdybden (interpoleret)
p75 75. percentil for grundvandsdybden (interpoleret)
p90 90. percentil for grundvandsdybden (interpoleret)
p95 95. percentil for grundvandsdybden (interpoleret)
p99 99. percentil for grundvandsdybden (interpoleret)
stdDev standardafvigelsen for grundvandsdybden
For hver boring findes op til 17 sæt pejlestatistik. For de 12 måneder, for de 4 årstider/sæsoner og totalt for hele pejlehistorikken.
pejlestastistik beregnes hvor der findes pejlinger i mindst 5 forskellige år indenfor den givne måned/sæson/totalt.