Versies vergeleken

Uitleg

  • Deze regel is toegevoegd.
  • Deze regel is verwijderd.
  • Opmaak is veranderd.


Informatie

Deze pagina werd gearchiveerd in 2023. Voor de meest recente versie, bekijk de bijgewerkte versie onder de tab 'Data aanleveren'.


Deze pagina beschrijft de mogelijkheden om sensordata m.b.t. grondwater/bodem toe te voegen aan DOV.

Overzicht van alle beschikbare API-calls (klik op de link voor meer info):

  • GET /chucknorris → healthcheck
  • POST /dovinstrumentserver/appinstrument/search/instrumenten/ → oplijsting van alle bekende instrumenten. In de postbody kunnen volgende optionele parameters worden meegegeven:
    • parameter instrumentTypeCode (optional) → filter instrumenten met deze instrumentTypeCode bv. {"instrumentTypeCode": "TMS"}
    • parameter text (optional) → filter instrumenten waarin deze tekst voorkomt in de naam, serienummer, ..., bv.  {"text": "diver_UA_"}
    • parameter textmatchers (optional) → specifieert de velden waarin text zal gaan zoeken, bv. [ "SERIENUMMER", "REFERENTIE", "NAAM"]
    • parameter matchers (optional) → geeft labels waarmee de instrumenten worden gefilterd, bv. ["GEKOPPELDE_INSTRUMENTEN", "ACTIEVE_INSTRUMENTEN", "NIET_ACTIEVE_INSTRUMENTEN", "NIET_GEKOPPELDE_INSTRUMENTEN" ]
  • /hfmetingen/instrumenten/
  • /hfmetingen/instrumenten/{idOrPermkey}/sensoren
    • GET → lijst opvragen van sensoren bij één instrument
  • /hfmetingen/instrumenten/{idOrPermkeyid}/sensoren/{sensorIdOrPermkey}/meetpuntensensordata  (!nog te bevestigen of dit endpoint nog geldig is)
    • GET → lijst opvragen van sensoren bij één instrument, met ook info over parameters, aantal datapunten, ...
  • /hfmetingen/instrumenten/{idOrPermkey}/sensoren/{sensorIdOrPermkey}/meetpunten
    • GET → opvragen van datapunten bij één sensor
    • POST → upload van 1 datapunt (
    • POST → upload van 1 datapunt (synchroon), meerdere datapunten (asynchroon) of een csv-bestand (asynchroon)
    • DELETE → verwijderen van datapunten
  • GET → opvragen van datapunten bij één sensorGET /hfmetingen/importlog/{id} → geeft de status van een import job
  • POST /hfmetingen/instrumentlink/ → instrument linken aan filter of bodemlocatie
  • GET /dovinstrumentserver/appinstrument/instrumenten/{id}/links/ → lijst opvragen van links bij een instrument (naar filter of bodemlocatie). Opgelet: werkt enkel met id, niet met permkey.
  • DELETE /hfmetingen/instrumentlink/{linkid}?comment=Geen%20commentaar → verwijderen van de link met het opgegeven linkid
  • GET /hfmetingen/meetreeksen/{domainObjectType}/{objectPermkey}/sensortypes → opvragen sensortypes bij een filter of bodemlocatie
  • GET /hfmetingen/meetreeksen/{domainObjectType}/{objectPermkey}/parameters/{parameterId}/meetpunten → opvragen van de meetreeksdata van een filter of bodemlocatie (als json, zip of csv)
  • GET /hfmetingen/meetreeksen/{domainObjectType}/{objectPermkey}/parameters/{parameterId}/sensortypes/{sensorIdentificatieCode}/meetpunten → ??
    • onduidelijk wat dit precies kan. Mogelijks een schrijffout waarbij /parameters/{parameterId} weggelaten moet worden. 
    • Volgende parameters kunnen worden meegegeven: startDatum, eindDatum, type (gevalideerd, niet_gevalideerd)
  • GET /hfmetingen/meetreeksen/{FILTER_PERMKEY}/sensortypes/{SENSORTYPE_CODE}/meetpunten → onduidelijk of deze call nog werkt. 

...

titleOudere pagina


Nuttige API-calls voor bodem (geen documentatie beschikbaar):

  • Bodemlocaties:
    • GET /dov-bodem-server/bodem/locatie/search/suggest?criteria={bodemlocatienaam}&maxresults=5 → opzoeken van bodemlocatie op naam (opgelet: kan meerdere resultaten geven, geeft [ ] indien niets gevonden)
    • GET /dov-bodem-server/bodemlocatie/{PermKey}  → info opvragen van één bodemlocatie (geeft 403 indien niet gevonden)
    • DELETE /dov-bodem-server/bodemlocatie/{IDofPermKey}?comment=Geen%20commentaar → verwijdert één bodemlocatie
  • BodemSites:
    • GET /dov-bodem-server/bodem/site/search/suggest?criteria={bodemsitenaam}&maxresults=5 → opzoeken van bodemsite op naam (opgelet: kan meerdere resultaten geven, geeft [ ] indien niets gevonden)
    • DELETE /dov-bodem-server/bodemsite/{IDofPermKey}?comment=Geen%20commentaar → verwijdert één bodemsite
  • Opdrachten:
    • GET /dov-proeven-server/opdracht/search/suggest?criteria=curieuze&maxresults=5  →  opzoeken van opdracht op naam (opgelet: kan meerdere resultaten geven, geeft [ ] indien niets gevonden)
    • DELETE /dov-proeven-server/opdrachten/{IDofPermKey}?comment=Geen%20commentaar → verwijdert één opdracht


API-calls voor codetabellen (geen documentatie beschikbaar):

Deze rest van deze pagina is een oudere versie van de API-documentatie 'sensordata grondwater'.

...

...

...

...

...

...

...

...

...

...

...



...

Waarschuwing
titleOudere pagina

Deze rest van deze pagina is een oudere versie van de API-documentatie 'sensordata grondwater', maar geeft een leesbare inleiding. 

De meest recente handleiding is te vinden op

https://www.dov.vlaanderen.be/portaal/api/instrument/api-guide.html

...

. Hierin zijn de meeste REST-calls terug te vinden, met hun beschikbare opties en attributen. Deze API-referentie wordt automatisch aangemaakt. 


Inhoudsopgave

Inleiding

Basisprincipes

...