Velkommen til RegObsServices API

Innhold

• 1 Introduksjon
  • 1.1 Om data i regObs
• 2 Versjoner
  • 2.1 Prod versjoner
  • 2.2 Demo versjon
  • 2.3 Test versjon
• 3 Hvordan bruke API'et
  • 3.1 Feil og HTTP statuskoder

1. Introduksjon

Dette APIet skal fases ut i nær fremtid, bruk heller regObsWeb API

RegObsServices API er basert på REST. Det bruker Open Data Protocol (OData) for å eksponere ut dataene. Mer om OData finner du her.

Dataene er fritt tilgjengelige for bruk under disse betingelsene.

1.1 Om data i regObs

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.

2. Versjoner

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.

2.1 Prod versjoner

• Versjon 3.1.0 (Opprettet: 29.03.2017)
  • Info kommer...
• Versjon 3.0.6 (Opprettet: 04.01.2017)
  • Versjonsnummeret er satt opp til 3.0.6 for å være i synk med Web og Api.
• Versjon 1.0.1 (Opprettet: 18.04.2016, oppdatert: 27.04.2016)
  • Pga en feil i databasen måtte vi gjøre om på en ID fra short til int. Det gjelder PictureID. I alle gamle versjoner av api'et vil view og tabeller som refererer dette feltet feile:
    View: AllRegistrationsV, AllRegistrationsIceV, AllRegistrationsLandslideV, AllRegistrationsWaterV, AllRegistrationsSnowV, IskartOneStationV, PictureRegistrationTidV, PictureV
    Tabell: Picture
  • Lagt til gammelt view: AvalancheWarningV, AvalancheWarning2V, AvalancheWarnProblemV
• Versjon 1.0.0 (Opprettet: 18.01.2016)
  • Lagt til ny tabell: AvalancheActivityObs2
  • Lagt til nytt view: AvalancheActivityObs2V
  • Urls tabellen er oppdatert, nytt felt: UsageFlagTID
  • IncidentURLs tabellen er oppdatert, nytt felt: UsageFlagTID
  • RegistrationMetaDataV er oppdatert, nye felt: SourceTID, SourceName, GeoHazardName
  • Slettet tabell: AvalancheWarning, AvalancheWarning2, AvalancheWarnProblem
  • Slettet view: AvalancheWarningV, AvalancheWarning2V, AvalancheWarning2RawV
• *DENNE TAR VI NED SNART*
  Versjon 0.9.7 (Opprettet: 19.01.2015)
  • Lagt til nye view: IskartAllRegistrationsV, IskartNewRegistrationV, IskartOneStationV og IskartRegionRegistrationV
• *DENNE TAR VI NED SNART*
  Versjon 0.9.6
  • Lag til: IceSkateability and IceCapacity
• *DENNE TAR VI NED SNART*
  Versjon 0.9.4
  • Lag til: GeneralObservationV, ColumnTestV, AvalancheObsV og AvalancheWarningV
• *DENNE TAR VI NED SNART*
  Versjon 0.9.1 (Opprettet: 08.05.2014)
  • Nye view: RegistrationMetaDataV

2.2 Demo versjon:

Versjonen blir oppdatert uten forvarsel.

• http://stg-h-web03.nve.no/regobsservices/OData.svc/

2.3 Test versjon:

Versjonen blir oppdatert uten forvarsel.

• http://tst-h-web03.nve.no/regobsservices_test/OData.svc/

3 Hvordan bruke API'et

Les mer på regObs bloggen om:

• Oppdateringer og nye versjoner
• Datamodell
• Veiledning om hvordan regObs fungerer
• Utviklerskolen i fem deler

For å gjøre spørringer mot APIet brukes OData URI konvensjoner. Les mer her.

3.1 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.

Kontakt

Spørsmål kan stilles til Ragnar Ekker.