GridTimeSeries data (GTS)

Introduksjon

Apiet leverer en tidsserie med data for et punkt.

For en demo åpne http://www.xgeo.no og klikk på et punkt i kartet. Da leses data fra apiet. Det vises i grafen og som en verdi for punktet.

Operasjoner

[ Base url: http://gts.nve.no/api ]
GridTimeSeries
Tidsserie data for en gridcelle
GET /GridTimeSeries/{x}/{y}/{startdato}/{sluttdato}/{temalag}.{format}
Returnerer tidsserie data for en et punkt i en grid celle

Parameters

Name Description
x *
string
(path)

x koordinat i UTM zone 33N

y *
string
(path)

y koordinat i UTM zone 33N

string
(path)

Man spesifiserer datoen slik: 'YYYY-MM-DD', hvis man skal spørre etter tre timers data, spesifiserer man time slik: format: 'YYYY-MM-DDT03'

string
(path)

Man spesifiserer datoen slik: 'YYYY-MM-DD', hvis man skal spørre etter tre timers data, spesifiserer man time slik: format: 'YYYY-MM-DDT03'

string
(path)

temalag er datagridet man vil spørre.

Tilgjengelige temalag finner man her: 

string
(path)

Man spesifiserer retur formatet med json (standard), xml eller csv.

 

Responses

Forklaring på feltene:

  • Theme: kodenavn på temalaget
  • FullName: fullt navn på temalaget
  • NoDataValue: verdi som indikerer at det ikke finnes en verdi
  • X: UTM zone 33N koordinat
  • Y: UTM zone 33N koordinat
  • StartDate: starttid for den returnerte tidsserien
  • EndDate: sluttdato for den returnerte tidsserien
  • PrognoseStartDate: brukes ikke foreløpig
  • Unit: måleenheten, f.eks: mm, cm, m etc.
  • TimeResolution: tidsoppløsning i minutter
  • Altitude: gjennomsnittlig meter over havet for grid cella
  • Data: liste med data, sortert fra startdato
{"Theme":"rr","FullName":"Døgnnedbør v2.0","NoDataValue":65535,"X":953709,"Y":7938592,"StartDate":"01.01.2018 06:00:00","EndDate":"02.01.2018 06:00:00","PrognoseStartDate":"null","Unit":"mm","TimeResolution":1440,"Altitude":129,"Data":[5,6]}
<GridTimeSerieModel>
  <Theme>rr</Theme>
  <FullName>Døgnnedbør v2.0</FullName>
  <NoDataValue>65535</NoDataValue>
  <X>953709</X>
  <Y>7938592</Y>
  <StartDate>01.01.2018 06:00:00</StartDate>
  <EndDate>02.01.2018 06:00:00</EndDate>
  <Unit>mm</Unit>
  <TimeResolution>1440</TimeResolution>
  <Altitude>129</Altitude>
  <Data>
    <anyType>5</anyType>
    <anyType>6</anyType>
  </Data>
</GridTimeSerieModel>
GET /GridTimeSeries/raw/{x}/{y}/{startdato}/{sluttdato}/{temalag}.{format}
Returnerer tidsserie data for en et punkt i en grid celle

Forskjellen fra standard GridTimeSerie er at rådataen returneres.

Parameters

Name Description
x *
string
(path)

x koordinat i UTM zone 33N

y *
string
(path)

y koordinat i UTM zone 33N

string
(path)

Man spesifiserer datoen slik: 'YYYY-MM-DD', hvis man skal spørre etter tre timers data, spesifiserer man time slik: format: 'YYYY-MM-DDT03'

string
(path)

Man spesifiserer datoen slik: 'YYYY-MM-DD', hvis man skal spørre etter tre timers data, spesifiserer man time slik: format: 'YYYY-MM-DDT03'

string
(path)

temalag er datagridet man vil spørre.

Tilgjengelige temalag finner man her: 

string
(path)

Man spesifiserer retur formatet med json (standard), xml eller csv.

 

GET /GridTimeSeries/Themes/{format}
Returnerer alle temalag

Parameters

Name Description
string
(path)

Man spesifiserer retur formatet med json (standard), xml eller csv.

 

Responses

{"Name":"rr","Fullname":"Døgnnedbør v2.0","FirstDateInTimeSerie":"1957-01-01","HumanReadableUnit":"mm","RawUnit":"mm","NoDataValue":65535,"TimeResolutionInMinutes":1440}
<Theme>
  <Name>rr</Name>
  <Fullname>Døgnnedbør v2.0</Fullname>
  <FirstDateInTimeSerie>1957-01-01</FirstDateInTimeSerie>
  <HumanReadableUnit>mm</HumanReadableUnit>
  <RawUnit>mm</RawUnit>
  <NoDataValue>65535</NoDataValue>
  <TimeResolutionInMinutes>1440</TimeResolutionInMinutes>
</Theme>
AreaTimeSeries
Tidserie data for flere gridceller
POST /AreaTimeSeries/ByGeoJson
Returnerer tidsserie data for alle gridcellene i polygonet (geojson)

Dette endepunktet bruker du hvis du har et polygon representert av geojson, rings. Her brukes POST metoden, så body for POSTen ser slik ut:

  • Rings: polygon representert av geojson
  • Format: json, xml eller csv (semicolon separert liste)
{
"Theme": "rr",
"StartDate": "2018-01-01",
"EndDate": "2018-01-02",
"Format": "json",
"Rings": "{"rings":[[[270915,6664551],[270872,6664362],[268633,6664858],[268682,6665047],[270405,6664796],[270518,6664739],[270915,6664551]]],"spatialReference":{"wkid":25833}}"
}

OBS! Her brukes en underliggende GIS tjeneste for å gjøre om geojson til gridcelleindekser, er polygonet stort kan dette ta lang tid. Hvis du vet listen med gridcelleindekser anbefaler vi å bruke endepunktet: ByCellIndexCsv

 

Hvis du vil kan du selv finne GridCelleindeksene ved å bruke denne tjenesten: 

https://gis3.nve.no/arcgis/rest/services/geoprocessing/SeNorgeCeller/GPServer/SeNorgeCeller

POST-body
								

Responses

Forklaring på respons feltene:

  • Theme: kodenavn på temalaget
  • FullName: fullt navn på temalaget
  • NoDataValue: verdi som indikerer at det ikke finnes en verdi
  • StartDate: starttid for den returnerte tidsserien
  • EndDate: sluttdato for den returnerte tidsserien
  • PrognoseStartDate: brukes ikke foreløpig
  • Unit: måleenheten, f.eks: mm, cm, m etc.
  • TimeResolution: tidsoppløsning i minutter
  • CellTimeSeries: list med data for hver enkelt celle
  • CellIndex: SeNorgeCelle ID
  • Altitude: gjennomsnittlig meter over havet for grid cella
  • Data: liste med data, sortert fra startdato
{"Theme":"rr","FullName":"Døgnnedbør v2.0","NoDataValue":65535,"StartDate":"01.01.2018 06:00:00","EndDate":"01.02.2018 06:00:00","PrognoseStartDate":"null","Unit":"mm","TimeResolution":1440,"CellTimeSeries":[{"Altitude":129,"CellIndex":1595670,"Data":[5,6]}]}
POST /AreaTimeSeries/ByCellIndexCsv
Returnerer tidsserie data for alle gridcellene i spørringen

Dette endepunktet bruker du hvis du vet gridcelleindeksene. Her brukes POST metoden, så body for POSTen ser slik ut:

  • CellIndexCsv: komma separert liste med GridCelle indekser
  • Format: json, xml eller csv (semicolon separert liste)
{
"Theme": "rr",
"StartDate": "2018-01-01",
"EndDate": "2018-01-02",
"Format": "json",
"CellIndexCsv": "1595670"
}
POST-body
								

Responses

Forklaring på respons feltene:

  • Theme: kodenavn på temalaget
  • FullName: fullt navn på temalaget
  • NoDataValue: verdi som indikerer at det ikke finnes en verdi
  • StartDate: starttid for den returnerte tidsserien
  • EndDate: sluttdato for den returnerte tidsserien
  • PrognoseStartDate: brukes ikke foreløpig
  • Unit: måleenheten, f.eks: mm, cm, m etc.
  • TimeResolution: tidsoppløsning i minutter
  • CellTimeSeries: list med data for hver enkelt celle
  • CellIndex: SeNorgeCelle ID
  • Altitude: gjennomsnittlig meter over havet for grid cella
  • Data: liste med data, sortert fra startdato
{"Theme":"rr","FullName":"Døgnnedbør v2.0","NoDataValue":65535,"StartDate":"01.01.2018 06:00:00","EndDate":"01.02.2018 06:00:00","PrognoseStartDate":"null","Unit":"mm","TimeResolution":1440,"CellTimeSeries":[{"Altitude":129,"CellIndex":1595670,"Data":[5,6]}]}
AggregationTimeSeries
Aggregerte data pr tidsoppløsning for flere gridceller
POST /AggregationTimeSeries/ByGeoJson
Returnerer aggregerte data pr tidsoppløsning for gridcellene i polygonet (geojson)

Dette endepunktet bruker du hvis du har et polygon representert av geojson, rings. Her brukes POST metoden, så body for POSTen ser slik ut:

  • Rings: polygon representert av geojson
  • Format: json, xml eller csv (semicolon separert liste)
  • Method: sum, min, max, avg, median
{
"Theme": "rr",
"StartDate": "2018-01-01",
"EndDate": "2018-01-02",
"Format": "json",
"Method": "sum",
"Rings": "{"rings":[[[270915,6664551],[270872,6664362],[268633,6664858],[268682,6665047],[270405,6664796],[270518,6664739],[270915,6664551]]],"spatialReference":{"wkid":25833}}"
}

OBS! Her brukes en underliggende GIS tjeneste for å gjøre om geojson til gridcelleindekser, er polygonet stort kan dette ta lang tid. Hvis du vet listen med gridcelleindekser anbefaler vi å bruke endepunktet: ByCellIndexCsv

 

Hvis du vil kan du selv finne GridCelleindeksene ved å bruke denne tjenesten:

https://gis3.nve.no/arcgis/rest/services/geoprocessing/SeNorgeCeller/GPServer/SeNorgeCeller

 

POST-body
								

Responses

Forklaring på respons feltene:

  • Theme: kodenavn på temalaget
  • FullName: fullt navn på temalaget
  • NoDataValue: verdi som indikerer at det ikke finnes en verdi
  • StartDate: starttid for den returnerte tidsserien
  • EndDate: sluttdato for den returnerte tidsserien
  • PrognoseStartDate: brukes ikke foreløpig
  • Unit: måleenheten, f.eks: mm, cm, m etc.
  • TimeResolution: tidsoppløsning i minutter
  • Method: Aggregeringsmetoden av alle cellene pr tidsoppøsning: sum, min, max, avg (gjennomsnitt), median
  • Data: liste med aggregerte data pr tidsoppløsning, sortert fra startdato
{"Theme":"rr","FullName":"Døgnnedbør v2.0","NoDataValue":65535,"StartDate":"01.01.2018 06:00:00","EndDate":"01.02.2018 06:00:00","PrognoseStartDate":"null","Unit":"mm","TimeResolution":1440,"Method":"sum","Data":[[5,6]]}
POST /AggregationTimeSeries/ByCellIndexCsv
Returnerer tidsserie data for alle gridcellene i spørringen

Dette endepunktet bruker du hvis du vet gridcelleindeksene. Her brukes POST metoden, så body for POSTen ser slik ut:

  • CellIndexCsv: komma separert liste med GridCelle indekser
  • Format: json, xml eller csv (semicolon separert liste)
  • Method: sum, min, max, avg, median
{
"Theme": "rr",
"StartDate": "2018-01-01",
"EndDate": "2018-01-02",
"Format": "json",
"Method": "sum",
"CellIndexCsv": "1595670"
}

 

POST-body
								

Responses

Forklaring på respons feltene:

  • Theme: kodenavn på temalaget
  • FullName: fullt navn på temalaget
  • NoDataValue: verdi som indikerer at det ikke finnes en verdi
  • StartDate: starttid for den returnerte tidsserien
  • EndDate: sluttdato for den returnerte tidsserien
  • PrognoseStartDate: brukes ikke foreløpig
  • Unit: måleenheten, f.eks: mm, cm, m etc.
  • TimeResolution: tidsoppløsning i minutter
  • Method: Aggregeringsmetoden av alle cellene pr tidsoppøsning: sum, min, max, avg (gjennomsnitt), median
  • Data: liste med aggregerte data pr tidsoppløsning, sortert fra startdato
{"Theme":"rr","FullName":"Døgnnedbør v2.0","NoDataValue":65535,"StartDate":"01.01.2018 06:00:00","EndDate":"01.02.2018 06:00:00","PrognoseStartDate":"null","Unit":"mm","TimeResolution":1440,"Method":"sum","Data":[[5,6]]}

Versjoner

Produksjon

Apiet er ikke versjonert. Det er kun en prod versjon.

Versjon Prod Base URL: https://gts.nve.no/api Opprettet: 01/01/2012