Velkommen til Snøskredvarsel API

Innhold

• 1 Introduksjon
• 2 Versjoner
  • 2.1 Prod versjoner
  • 2.2 Test versjon
• 3 Hvordan bruke API'et
  • 3.1 Format
  • 3.2 Url oppbygging
    • 3.2.1 Swagger
    • 3.2.2 Urlformat
  • 3.3 Hent metode
    • 3.3.1 AvalancheWarningByCoordinates
    • 3.3.2 AvalancheWarningByRegion
    • 3.3.3 RegionSummary
    • 3.3.4 Warning
    • 3.3.5 Region
  • 3.4 Datatype
    • 3.4.1 Simple
    • 3.4.2 Detail
    • 3.4.3 Obs
  • 3.5 Språknøkkel
  • 3.6 Dato spesifisering
• 4 Gyldige verdier
  • 4.1 Forklaring til ValidExpositions
  • 4.2 Forklaring til feltene: ExposedHeight1, ExposedHeight2, ExposedHeightFill
  • 4.3 Diverse dataverdier
• 5 Eksempel XML
  • 5.1 AvalancheWarningSimple
  • 5.2 AvalancheWarningDetail
  • 5.3 ObsWarning
  • 5.4 AvalancheWarningByRegion
  • 5.5 AvalancheWarningByCoordinates
  • 5.6 RegionSummary
  • 5.7 RegionSummaryObs
  • 5.8 Warning
  • 5.9 Region
• 6 Regioner
  • 6.1 A regioner
  • 6.2 B regioner
• 7 Kontakt

1 Introduksjon

Snøskredvarsel API er basert på REST. Det leverer data som XML og JSON (standard), les mer om format. Kun GET er støttet.

Dataene er fritt tilgjengelige for bruk.

2 Versjoner

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

2.1 Prod versjoner

• Versjon 3.0.0 (Opprettet: 23.11.2016)
  • Helt nye varslingsregioner fra i år
  • Nye felter i AvalancheWarningSimple:
    • RegionTypeId (Id for regions type, A eller B region)
    • RegionTypeName (Navn for regions type, A eller B region)
  • Ny hent metode: Warning
    • Warning, leverer lister med varsel
    • Region, leverer list over alle regionene (A og B regioner)
  • Region, leverer list over alle regionene (fylker og kommuner)
  • Har lagt til swagger for ytterligere dokumentasjon av API'et
• Versjon 2.0.2 (Opprettet: 19.11.2014)
  • Endringer i AvalancheWarningDetail:
    • Nytt felt:
      • EmergencyWarning (tekstfelt med meldinger om det er spesielle snøskredfarer)
    • Nye felt i AvalancheProblem:
      • AvalPropagationId (id for utbredelse)
      • AvalPropagationName (tekstfelt som beskriver utbredelse)
      • AvalancheAdvice (tekstfelt for ferdselsråd)
      • AvalancheTypeId (Id felt for skredtype)
      • AvalancheTypeName (tekstfelt for skredtype)
      • AvalancheProblemTypeId (Id felt for skredproblemtype)
      • AvalancheProblemTypeName (tekstfelt for skredproblemtype)
    • Fjernet felt fra AvalancheProblem:
      • ProbabilityCombined
  • Nye verdier oppdatert for AvalancheExt, AvalCause
  • Ny datatype, Obs. Den leverer ObsWarning.
  • Varslingsregioner er endret. Harstad, Hemsedalsfjella, Hallingskarvet og Nordfjord er fjernet. Ny region for Hemsedalsfjella og Hallingskarvet er Hallingdag. I tillegg er alle fylker satt opp som regioner.
• Test

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

2.2 Test versjon

Vi har en test versjon som kan brukes for å teste mot. Denne blir oppdatert uten forvarsel. Og vil alltid inneholde de siste endringene.
Testversjon:

• AvalancheWarningByCoordinates: http://api01.nve.no/hydrology/forecast/avalanche/test/api/AvalancheWarningByCoordinates/Detail/69.455819/19.907227/1/2014-03-13/2014-03-13
• AvalancheWarningByRegion: http://api01.nve.no/hydrology/forecast/avalanche/test/api/AvalancheWarningByRegion/Detail/3007/1/2014-03-13/2014-03-13
• RegionSummary: http://api01.nve.no/hydrology/forecast/avalanche/test/api/RegionSummary/Detail/1
• Warning
  • Liste av varsler for tre dager: http://api01.nve.no/hydrology/forecast/avalanche/test/api/Warning/All/1
  • Liste av varsler for tre dager: http://api01.nve.no/hydrology/forecast/avalanche/test/api/Warning/Region/3001/1
  • Et varsel basert på Id: http://api01.nve.no/hydrology/forecast/avalanche/test/api/Warning/Id/100360/1
• Region, leverer liste over alle regionene (A og B regioner): http://api01.nve.no/hydrology/forecast/avalanche/test/api/Region/

Her er vår presentasjon av test dataene: http://beta.varsom.no/snoskred/

3 Hvordan bruke API'et

3.1 Format

API'et leverer data på to formater, XML og JSON. JSON er standard format om ikke noe er spesifisert. Man spesifiserer ved å sette Accept i request header.

Accept:

• application/json
• application/xml

3.2 Url oppbygging

3.2.1 Swagger

For å teste API'et kan man bruke swagger: http://api01.nve.no/hydrology/forecast/avalanche/test/swagger/ui/index#/
Det er noe små feil i genereringen av swagger eksemplene: den krever at alle parametre er med, det må de ikke.

3.2.2 Urlformat

Gjeldene for: AvalancheWarningByCoordinates, AvalancheWarningByRegion, RegionSummary
http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/{hent metode}/{datatype}/{koordinater eller regionsid}/{språk nøkkel}/{startdato}/{sluttdato}

Gjeldene for Warning:
http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Warning/{hent metode}/{språk nøkkel}/{startdato}/{sluttdato}

3.3 Hent metode (koordinater, regionsid, summary eller varselliste)

Man kan hente varsler basert på lat/lon koordinater eller ved regionsid (liste med regioner ligger i bunn), i tillegg finnes en summary med varsler for alle regioner for i dag, i morgen og over i morgen

3.3.1 AvalancheWarningByCoordinates

Man kan hente ut varsler basert på koordinater. Vi støtter lat/lon. Her leveres en liste av varsler basert på antall dager spesifisert av datoene og datatypen
Eks: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/AvalancheWarningByCoordinates/Detail/69.455819/19.907227/1/2014-03-13/2014-03-13

3.3.2 AvalancheWarningByRegion

Man kan hente ut varsler basert på en regionsid. Her leveres en liste av varsler basert på antall dager spesifisert av datoene og datatypen
Eks: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/AvalancheWarningByRegion/Detail/3022/1/2016-11-25/2016-11-25

3.3.3 RegionSummary

Man kan hente ut en oversikt over varsler for alle regioner (inkludert A og B regioner) for i dag, i morgen og over i morgen. Her kan man også spesifisere datatypen
Simple og Detail leverer RegionSummary, og alltid for tre dager. Obs leverer RegionSummaryObs og bare hvis det finnes B regioner med faregrad 4 eller 5.
Eks: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/RegionSummary/Detail/1

3.3.4 Warning

Leverer en liste av varsler (AvalancheWarningDetail). Endten for alle regioner (All), for en region (Region/3001) og man kan spesifisere datoene. Eller man kan hente ut et spesifikt varsel basert på Id (Id/123456)
Hent metoder:

• All, liste av varsler for alle regioner: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Warning/All/1
• Region, liste av varsler for en region: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Warning/Region/3001/1
• Id, et varsel for en Id: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Warning/Id/123456/1

3.3.5 Region

Region inneholder en liste over alle regioner (A og B regioner). Man kan spesifisere type region med TypeId (A = 10, B = 20).
Eks:

• Alle: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Region/
• A regioner: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Region/10/
• B regioner: http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/Region/20/

3.4 Datatype

3.4.1 Simple

3.4.1 Detail

3.4.1 Obs

3.5 Språknøkkel

Leveres på to forskjellige språk.
Norsk = 1
Engelsk = 2

3.6 Dato spesifisering. (startdato/sluttdato)

Hvis man ikke spesifiserer dato, får man tre varsler, idag, i morgen og over i morgen.
http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/AvalancheWarningByRegion/Detail/11/1/

Hvis man spesifiserer bare startdato, får man tre varsler, fra datoen som er spesifisert og to dager frem:
http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/AvalancheWarningByRegion/Detail/11/1/2014-03-13

Hvis man spesifiserer start- og sluttdato, får man varslene for de datoene:
http://api01.nve.no/hydrology/forecast/avalanche/v3.0.0/api/AvalancheWarningByRegion/Detail/11/1/2014-03-10/2014-03-13

4 Gyldige verdier

4.1 Forklaring til ValidExpositions

ValidExpositions er en rekke med 0 og 1 som representerer alle himmelretninger. 1 betyr at terreng i himmelretningen er utsatt. Rekka inneholder 8 tegn, f. eks. 10000011
Rekka over representerer utsatt terreng i himmelretningene: Nord, Vest og Nord-Vest.

Rekka starter fra Nord, og går videre med klokka til Nord-Øst, Øst, Sør-Øst, Sør, Sør-Vest, Vest, Nord-Vest

4.2 Forklaring til feltene: ExposedHeight1, ExposedHeight2, ExposedHeightFill

ExposedHeight1 kan ha verdier fra 0 - 2500
ExposedHeight2 kan ha verdier fra 0 til verdien av ExposedHeight1

ExposedHeightFill kan ha verdiene:

• 0 = Ikke gitt
• 1 = Gjelder over gitt høyde (ExposedHeight1)
• 2 = Gjelder under gitt høyde (ExposedHeight1)
• 3 = Gjelder over og under gitt høyde (ExposedHeight1, ExposedHeight2)
• 4 = Gjelder mellom gitt høyde (ExposedHeight1, ExposedHeight2)

4.3 Diverse dataverdier

AvalancheType

NO

• 0 - Ikke gitt
• 10 - Flakskred
• 20 - Løssnøskred

EN

• 0 - Not given
• 10 - Slab avalanche
• 20 - Loose snow avalanche

AvalancheProblemType

NO

• 0 - Ikke gitt
• 3 - Tørre løssnøskred
• 5 - Våte løssnøskred
• 7 - Nysnøflak
• 10 - Fokksnø
• 20 - Nysnø
• 30 - Vedvarende svakt lag
• 37 - Dypt vedvarende svakt lag
• 40 - Våt snø
• 45 - Våte flakskred
• 50 - Glideskred

EN

• 0 - Not given
• 3 - Loose dry avalanches
• 5 - Loose wet avalanches
• 7 - New snow slab
• 10 - Wind slab avalanches
• 20 - New snow
• 30 - Persistent slab avalanches
• 37 - Persistent deep slab avalanches
• 40 - Wet snow
• 45 - Wet slab avalanches
• 50 - Glide avalanche

AvalancheExt

NO

• 0 - Ikke gitt
• 10 - Tørre løssnøskred
• 15 - Våte løssnøskred
• 20 - Tørre flakskred
• 25 - Våte flakskred

EN

• 0 - Not given
• 10 - Loose dry avalanche
• 15 - Loose wet avalanche
• 20 - Dry slab avalanche
• 25 - Wet slab avalanche

AvalCause

NO

• 0 - Ikke gitt
• 10 - Nedføyket svakt lag med nysnø
• 11 - Nedsnødd eller nedføyket overflaterim
• 12 - Nedsnødd eller nedføyket svakt lag med sprøhagl
• 13 - Nedsnødd eller nedføyket kantkornet snø
• 14 - Dårlig binding mellom glatt skare og overliggende snø
• 15 - Dårlig binding mellom lag i fokksnøen
• 16 - Kantkornet snø ved bakken
• 17 - Kantkornet snø rundt vegetasjon
• 18 - Kantkornet snø over skarelag
• 19 - Kantkornet snø under skarelag
• 20 - Vann ved bakken/smelting fra bakken
• 21 - Snødekket gjennomfuktet og ustabilt fra overflaten
• 22 - Opphopning av vann i/over lag i snødekket
• 23 - Snødekket er overmettet av vann
• 24 - Ubunden snø
• 25 - Regn / temperaturstigning / soloppvarming

EN

• 0 - Not given
• 10 - Buried weak layer of new snow
• 11 - Buried weak layer of surface hoar
• 12 - Buried weak layer of graupel
• 13 - Buried weak layer of faceted snow near surface
• 14 - Poor bonding between crust and overlying snow
• 15 - Poor bonding between layers in wind deposited snow
• 16 - Buried weak layer of faceted snow near the ground
• 17 - Buried weak layer of faceted snow near vegetation
• 18 - Buried weak layer of faceted snow above a crust
• 19 - Buried weak layer of faceted snow beneath a crust
• 20 - Wet snow/melting near the ground
• 21 - Wet snow on the surface
• 22 - Water pooling in/above snow layers
• 23 - Water-saturated snow
• 24 - Loose snow
• 25 - Rain / rise in temperature / solar heating

AvalProbability

NO

• 0 - Ikke gitt
• 2 - Lite sannsynlig
• 3 - Mulig
• 5 - Sannsynlig
• 7 - Meget sannsynlig

EN

• 0 - Not given
• 2 - Unlikely
• 3 - Possible
• 5 - Likely
• 7 - Very likely

AvalTriggerSimple

NO

• 0 - Ikke gitt
• 10 - Stor tilleggsbelastning
• 21 - Liten tilleggsbelastning
• 22 - Naturlig utløst

EN

• 0 - Not given
• 10 - High additional load
• 21 - Low additional load
• 22 - Spontaneous release

DestructiveSize

NO

• 0 - Ikke gitt
• 1 - Små
• 2 - Middels
• 3 - Store
• 4 - Svært store
• 5 - Ekstreme

EN

• 0 - Not given
• 1 - Small
• 2 - Medium
• 3 - Large
• 4 - Very large
• 5 - Extreme

AvalPropagation

NO

• 0 - Ikke vurdert
• 1 - Få bratte heng
• 2 - Noen bratte heng
• 3 - Mange bratte heng
• 4 - De fleste bratte heng
• 5 - Også i mindre bratt terreng

EN

• 0 - Not given
• 1 - Isolated steep slopes
• 2 - Some steep slopes
• 3 - Many steep slopes
• 4 - Most steep slopes
• 5 - Also in moderately steep terrain

DangerLevel

NO

• 0 - Ikke vurdert
• 1 - Liten
• 2 - Moderat
• 3 - Betydelig
• 4 - Stor
• 5 - Meget stor

EN

• 0 - Not given
• 1 - Low
• 2 - Moderate
• 3 - Considerable
• 4 - High
• 5 - Extreme

EmergencyWarning

NO

• Faregrad 3: Enkelte store naturlige utløste skred kan forekomme
• Faregrad 4: Noen store naturlige utløste skred forventes
• Faregrad 5: Mange store naturlige utløste skred forventes

EN

• Faregrad 3: A few bigger avalanche may occur
• Faregrad 4: Some big avalanche are expected
• Faregrad 5: Many big avalanches are expected

5 Eksempel XML

5.1 AvalancheWarningSimple

En enkel versjon av varselet som ikke inneholder mer enn akkurat nødvendig for å vise i en oversikt.

<AvalancheWarningSimple>
	<RegId>10928</RegId>
	<RegionId>3007</RegionId>
	<RegionName>Vest-Finnmark</RegionName>
	<RegionTypeId>10</RegionId>
	<RegionTypeName>A</RegionName>
	<ValidFrom>2014-03-13T00:00:00</ValidFrom>
	<ValidTo>2014-03-13T23:59:00</ValidTo>
	<NextWarningTime>2014-03-13T16:00:00</NextWarningTime>
	<PublishTime>2013-11-12T12:08:15.953</PublishTime>
	<DangerLevel>4</DangerLevel>
	<MainText>Hovedbudskap (norsk)</MainText>
</AvalancheWarningSimple>
	

5.2 AvalancheWarningDetail

inneholder alle datafelter

<AvalancheWarningDetail>
	<RegId>10928</RegId>
	<RegionId>3007</RegionId>
	<RegionName>Vest-Finnmark</RegionName>
	<RegionTypeId>10</RegionId>
	<RegionTypeName>A</RegionName>
	<MunicipalityName>ALTA</MunicipalityName>
	<UtmEast>786087</UtmEast>
	<UtmNorth>7803739</UtmNorth>
	<UtmZone>33</UtmZone>
	<ValidFrom>2014-03-13T00:00:00</ValidFrom>
	<ValidTo>2014-03-13T23:59:00</ValidTo>
	<NextWarningTime>2014-03-13T16:00:00</NextWarningTime>
	<PublishTime>2013-11-12T12:08:15.953</PublishTime>
	<DangerLevel>4</DangerLevel>
	<DangerLevelName>4 Stor</DangerLevelName>
	<MainTextMainText>Hovedbudskap (norsk)</MainText>
	<AvalancheWarning>Nåsituasjon basert på observasjoner</AvalancheWarning>
	<AlpineWeather>Fjellvær</AlpineWeather>
	<Author>anders@nve</Author>
	<AvalancheDanger>Snøskredfare</AvalancheDanger>
	<Emergencywarning>Ikke gitt</Emergencywarning>
	<AvalancheProblems>
		<AvalancheProblem>
			<AvalancheTypeId>10</AvalancheTypeId>
			<AvalancheTypeName>Flakskred</AvalancheTypeName>
			<AvalancheProblemTypeId>30</AvalancheProblemTypeId>
			<AvalancheProblemTypeName>Vedvarende svakt lag</AvalancheProblemTypeName>
			<AvalancheExtId>15</AvalancheExtId>
			<AvalancheExtName>Våte løssnøskred</AvalancheExtName>
			<AvalCauseId>21</AvalCauseId>
			<AvalCauseName>Snødekket gjennomfuktet og ustabilt fra overflaten</AvalCauseName>			
			<DestructiveSizeExtId>6</DestructiveSizeExtId>
			<DestructiveSizeExtName>Store</DestructiveSizeExtName>
			<AvalProbabilityId>7</AvalProbabilityId>
			<AvalProbabilityName>Meget sannsynlig</AvalProbabilityName>
			<AvalTriggerSimpleId>21</AvalTriggerSimpleId>
			<AvalTriggerSimpleName>Liten tilleggsbelastning</AvalTriggerSimpleName>
			>Avalpropagationid>3>/Avalpropagationid>
			>Avalpropagationname>Mange bratte heng>/Avalpropagationname>
			<ExposedHeightFill>1</ExposedHeightFill>
			<ExposedHeight1>600</ExposedHeight1>
			<ExposedHeight2>0</ExposedHeight2>					
			<ValidExpositions>10000011</ValidExpositions>
			<Avalancheadvice>
				Det krever mye kunnskap å gjenkjenne hvor det svake laget er gjemt. Drønnelyder, 
				skytende sprekker og ferske skred er tydelige tegn, men fravær av tegn betyr ikke at det er trygt. 
				Gjør svært konservative vegvalg, særlig i ukjent terreng, etter snøfall og perioder med temperaturstigning. 
				Hold god avstand til hverandre og til løsneområdene. NB, fjernutløsning er mulig.
			</Avalancheadvice>
		<avalanchetypename>Flakskred</avalanchetypename>
		</AvalancheProblem>		
	</AvalancheProblems>	
	<LangKey>1</LangKey>		
</AvalancheWarningDetail>
	

5.3 ObsWarning

En enkel versjon av fylkesvarsel (Obs-varsel) som ikke inneholder mer enn akkurat nødvendig for å vise i en oversikt.

<ObsWarning>
	<RegionId>69</RegionId>
	<RegionName>Finnmark</RegionName>
	<ValidFrom>2014-03-13T00:00:00</ValidFrom>
	<ValidTo>2014-03-13T23:59:00</ValidTo>
	<NextWarningTime>2014-03-13T16:00:00</NextWarningTime>
	<PublishTime>2013-11-12T12:08:15.953</PublishTime>
	<DangerLevel>4</DangerLevel>
	<Text>Varsel om STOR snøskredfare: Finnmark</Text>
</ObsWarning>
	

5.4 AvalancheWarningByRegion

En liste av AvalancheWarningSimple, AvalancheWarningDetail eller ObsWarning

<ArrayOfAvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	...
</ArrayOfAvalancheWarningSimple>
	

5.5 AvalancheWarningByCoordinates

En liste av AvalancheWarningSimple, AvalancheWarningDetail eller ObsWarning

<ArrayOfAvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	<AvalancheWarningSimple>...</AvalancheWarningSimple>
	...
</ArrayOfAvalancheWarningSimple>
	

5.6 RegionSummary

En liste av RegionSummary elementer som igjen inneholder en liste av AvalancheWarningSimple, AvalancheWarningDetail.
AvalancheWarningDetail arver fra AvalancheWarningSimple og derfor blir typen slik <AvalancheWarningSimple i:type="AvalancheWarningDetail">

<ArrayOfRegionSummary >
	<RegionSummary>
		<Id>6</Id>
		<Name>Alta</Name>
		<AvalancheWarningList>
			<AvalancheWarningSimple>...</AvalancheWarningSimple>
			<AvalancheWarningSimple>...</AvalancheWarningSimple>
			<AvalancheWarningSimple>...</AvalancheWarningSimple>
		</AvalancheWarningList>
	</RegionSummary>
	...
</ArrayOfRegionSummary >
	

5.7 RegionSummaryObs

En liste av RegionSummaryObs elementer som igjen inneholder en liste av ObsWarning

<ArrayOfRegionSummaryObs  >
	<RegionSummaryObs>
		<Id>69</Id>
		<Name>Finnmark</Name>
		<ObsWarningList>
			<ObsWarning>...</ObsWarning>
			<ObsWarning>...</ObsWarning>
			<ObsWarning>...</ObsWarning>
		</ObsWarningList>
	</RegionSummaryObs>
	...
</ArrayOfRegionSummaryObs  >
	

5.8 Warning

En liste av AvalancheWarningDetail

<ArrayOfAvalancheWarningDetail>
	<AvalancheWarningDetail>...</AvalancheWarningDetail>
	<AvalancheWarningDetail>...</AvalancheWarningDetail>
	<AvalancheWarningDetail>...</AvalancheWarningDetail>
	...
</ArrayOfAvalancheWarningDetail>
	

5.8 Region

En liste av Region

<ArrayOfRegion>
	<Region>
		<Id>3001</Id>
		<Name>Svalbard øst</Name>
		<TypeId>20</TypeId>
		<TypeName>B</TypeName>
	</Region>
	...
</ArrayOfRegion>
	

6 Regioner

Shapefile over regionene kan lastes ned her: http://nedlasting.nve.no/gis/

6.1 A regioner

Et definert område der det utarbeides og publiseres et snøskredvarsel daglig i perioden 1. desember til 31. mai. Typisk størrelse er 3000-5000 km2.

6.2 B regioner

Et definert område der det utarbeides et snøskredvarsel når snøskredfaren vurders til faregrad 4/5 basert på meteoroligiske forhold. En B-region er ofte større enn en A-region.

7 Kontakt

Spørsmål kan stilles til Anders Wartiainen.