RegObs

Introduksjon

Dette APIet skal kun brukes til lesing, for å sende inn en registrering bruk regObsWeb API.

regObs er et registreringsverktøy for naturfarerelaterte observasjoner. Data brukes av de nasjonale varslingstjenestene, men er også tilgjengelig for andre som vil gjøre egne vurderinger.

Bruk

Data på regObs produseres av brukerne av regObs og foreligger ”som den er”. Den kan inneholde feil og utelatelser. NVE gir ingen garantier for informasjonens aktualitet og tar ikke ansvar for at data kan gi feil eller villedende informasjon. Antall stjerner (1-5) beskriver kompetansenivået til den som leverer observasjoner. Uten stjerner er kompetansen ukjent eller lav.

Navngivelse av datakilden gjøres ved å merke bearbeidelsen med:

  • regObs datasett: data fra regObs vises med regObs logo, etterfulgt av en tekst 
  • regObs enkeltdata: i tilfellene på regObs hvor det er en bestemt kilde som brukes (eg. et bilde eller en observasjon) henvises det til den aktuelle observatøren.
  • øvrige tilfeller: ved å merke bearbeidelsen med NVEs logo, etterfulgt av en tekst.

Feil og HTTP statuskoder

Ved feil returneres HTTP statuskode 400 med en tekst som beskriver feilen. Mer om OData statuskoder finner du her.
200 returneres ved suksess.

HTTPS

  • For å få APIet via https så må man spesifisere https i urlen. Det er ingen redirect forløpig.

OData

RegObsServices API er basert på REST. Det bruker OData for å eksponere ut dataene.

For de som er ukjent med OData så står dette for Open Data Protocol. Kort fortalt er dette en webprotocol som gjør det mulig å gjøre spørringer og oppdatere data via kjente webteknologier som http, atom og Json. Mer utførende forklaring og detaljer finner du på http://www.odata.org/. 

Versjoner

Produksjon

Det vil komme nye versjoner av APIet, så det er et versjonsnummer i lenken. Vi lar gamle versjoner leve i 6 måneder før de blir fjernet uten varsel.

Versjon 3.2.0 (ReadOnly) Base URL: https://api.nve.no/hydrology/regobs/v3.2.0/Odata.svc Opprettet: 05/09/2017
  • Nye tabeller:
    • DamageObs, DamageObsPicture, WaterLevelMeasurement, WaterLevelMeasurementPicture 
  • Dette API'et er nå kun for lesing, skrive rettigheter vil bli fjernet fra de andre versjonene uten forvarsel
    • Bruk regObsWebAPI for skriving.
Versjon 3.1.0 (ReadOnly) Base URL: https://api.nve.no/hydrology/regobs/v3.1.0/Odata.svc Opprettet: 29/03/2017

Test

Demo og Test blir oppdatert uten forvarsel.

Versjon Demo (ReadOnly) Base URL: http://stg-h-web03.nve.no/regobsservices/Odata.svc
Versjon Test (ReadOnly) Base URL: http://tst-h-web03.nve.no/regobsservices_test/Odata.svc