RegObs WebAPI

Introduksjon

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.

Her er vår presentasjon av dataene: http://www.regobs.no/

Bruk

Api'et er i hovedsak tenkt å tilgjengeliggjøre registrering av data til regObs. For å registrere data via api'et trenger du å få tilgang via NVE sitt regobs team. Ta kontakt på epost raek@nve.no.

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.

 

Format

API'et leverer data som JSON

Registrering av en hendelse

En registrering gjøres ved å sende ved å sende selve registeringen som en json-string til web service.

$.ajax({
   url:"https://api.nve.no/hydrology/regobs/webapi/registration,
   type: "post",
   contentType: "application/json",
   headers: {
      regObs_apptoken: "00000000-0000-0000-0000-00000000",
      ApiJsonVersion": "3.1.0.38472"
   },
   data: dataToSend
}).done().fail();

En registrering består i grove trekk av

  • Type hendelse (snø, is, vann eller jord)
  • Observatør. Dette er en unik id (guid) og kommer fra regObs systemet.
  • Tidspunkt for hendseln
  • Lokasjon
  • Observasjoner/hendelser

Les mer her.

Registreringsobjektet (dataToSend)

Selve registrering sendes som en json string. Se her for mer informasjon om oppbygningen av denne strengen.

Swagger

Bruk swagger for ytterligere info om api endepunker:

https://api.nve.no/hydrology/RegObs/webapi_v3.2.0/swagger/ui/index

Versjoner

Produksjon

Det vil komme nye versjoner av APIet, så det er et versjonsnummer i lenken. Vi lar gamle versjoner leve en stund, men de blir fjernet uten forvarsel.

Versjon 3.2.0.* Base URL: api.nve.no/hydrology/regobs/webapi_v3.2.0 Opprettet: 05/09/2017
  • Det er nå paginering på "search" endepunktene:
    • Request: Offset, NumberOfRecords
    • Response: Offset, ResultsInPage, TotalMatches
  • Nye skjema for vann-registreringer:
    • Skade: DamageObs
    • Vannstand: WaterlevelMeasurement
Versjon 3.1.0.* Base URL: api.nve.no/hydrology/regobs/webapi_v3.1.0
  • Swagger er implementert for bedre dokumentasjon av APIet
Versjon 2.0.0.* Base URL: api.nve.no/hydrology/regobs/webapi_v2.0.0

Ny observasjonstype: AvalancheActivityObs2, bruk den i stedenfor AvalancheActivityObs

Versjon 1.2.* Base URL: api.nve.no/hydrology/regobs/webapi

Test

Latest er alltid siste versjon av API'et, den blir oppdatert uten forvarsel. Hvis du vil være trygg på at det ikke er "breaking changes" i API'et du bruker så bruk en spesifikk verjson.

Demo og Test blir oppdatert uten forvarsel.

Versjon Latest Base URL: api.nve.no/hydrology/regobs/webapi_latest
Versjon Demo Base URL: api.nve.no/hydrology/demo/regobs/webapi
Versjon Test Base URL: tst-h-web03.nve.no/regobswebapi