Api session overlay: Difference between revisions
No edit summary |
No edit summary |
||
| Line 58: | Line 58: | ||
===='''Examples==== | ===='''Examples==== | ||
''' | '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&token=API_TOKEN</syntaxhighlight> | ||
'''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight> | |||
'''Query with Scale: 50% (scale=0.5)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight> | |||
'''Query for Timeframe: 0 (timeframe=0''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight> | |||
'''Query for MapType: CURRENT (maptype=CURRENT)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight> | |||
'''Query for export CRS: EPSG:3857''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | |||
'''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight> | |||
'''Query with Scale: 50% (scale=0.5)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight> | |||
'''Query for Timeframe: 0 (timeframe=0''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight> | |||
'''Query for MapType: CURRENT (maptype=CURRENT)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight> | |||
'''Query for export CRS: EPSG:3857''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | |||
'''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&token=API_TOKEN</syntaxhighlight> | |||
''' | '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight> | ||
''' | '''Query with Scale: 50% (scale=0.5)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight> | ||
''' | '''Query for Timeframe: 0 (timeframe=0''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight> | ||
''' | '''Query for MapType: CURRENT (maptype=CURRENT)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight> | ||
''' | '''Query for export CRS: EPSG:3857''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | ||
'''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''': | '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&token=API_TOKEN</syntaxhighlight> | ||
'''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''': | '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight> | ||
'''Query with Scale: 50% (scale=0.5)''': | '''Query with Scale: 50% (scale=0.5)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight> | ||
'''Query for Timeframe: 0 (timeframe=0''': | '''Query for Timeframe: 0 (timeframe=0''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight> | ||
'''Query for MapType: CURRENT (maptype=CURRENT)''': | '''Query for MapType: CURRENT (maptype=CURRENT)''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight> | ||
'''Query for export CRS: EPSG:3857''': | '''Query for export CRS: EPSG:3857''': | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay. | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | ||
'''GeoJSON: Legend Points (center)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''GeoJSON: Legend Polygons''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''GeoJSON: Legend MultiPolygons''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''GeoPackage: Legend Points (center)''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''GeoPackage: Legend Polygons''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKEN</syntaxhighlight> | |||
'''GeoPackage: Legend MultiPolygons''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN</syntaxhighlight> | |||
{{article end | {{article end | ||
Revision as of 15:28, 17 June 2026
API Endpoint: api/session/overlay.{format}
GET overlay.{format}
API Endpoint: api/session/overlay.{format}
Parameters:
| Name | Location | Type | Default value |
|---|---|---|---|
| format | Path | String | |
| crs | Query | String | EPSG:3857 |
| id | Query | Integer | -1 |
| maptype | Query | Map Type | MAQUETTE |
| difference | Query | boolean | false |
| timeframe | Query | int | 0 |
| scale | Query | double | 1 |
| value | Query | HeightOperator | |
| bbox | Query | String |
Examples
Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250):
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&token=API_TOKENQuery with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250):
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&bbox=0,125,125,250&token=API_TOKENQuery with Scale: 50% (scale=0.5):
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&scale=0.5&token=API_TOKENQuery for Timeframe: 0 (timeframe=0:
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&timeframe=0&token=API_TOKENQuery for MapType: CURRENT (maptype=CURRENT):
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&maptype=CURRENT&token=API_TOKENQuery for export CRS: EPSG:3857:
https://engine.tygron.com/api/session/overlay.geotiff?id=ID&crs=3857&token=API_TOKENComplete Grid Overlay (upper-left is 0,0 and lower-right is 250,250):
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&token=API_TOKENQuery with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250):
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&bbox=0,125,125,250&token=API_TOKENQuery with Scale: 50% (scale=0.5):
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&scale=0.5&token=API_TOKENQuery for Timeframe: 0 (timeframe=0:
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&timeframe=0&token=API_TOKENQuery for MapType: CURRENT (maptype=CURRENT):
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&maptype=CURRENT&token=API_TOKENQuery for export CRS: EPSG:3857:
https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&crs=3857&token=API_TOKENComplete Grid Overlay (upper-left is 0,0 and lower-right is 250,250):
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&token=API_TOKENQuery with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250):
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&bbox=0,125,125,250&token=API_TOKENQuery with Scale: 50% (scale=0.5):
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&scale=0.5&token=API_TOKENQuery for Timeframe: 0 (timeframe=0:
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&timeframe=0&token=API_TOKENQuery for MapType: CURRENT (maptype=CURRENT):
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&maptype=CURRENT&token=API_TOKENQuery for export CRS: EPSG:3857:
https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&crs=3857&token=API_TOKENComplete Grid Overlay (upper-left is 0,0 and lower-right is 250,250):
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&token=API_TOKENQuery with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250):
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&bbox=0,125,125,250&token=API_TOKENQuery with Scale: 50% (scale=0.5):
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&scale=0.5&token=API_TOKENQuery for Timeframe: 0 (timeframe=0:
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&timeframe=0&token=API_TOKENQuery for MapType: CURRENT (maptype=CURRENT):
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&maptype=CURRENT&token=API_TOKENQuery for export CRS: EPSG:3857:
https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKENGeoJSON: Legend Points (center):
https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKENGeoJSON: Legend Polygons:
https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKENGeoJSON: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKENGeoPackage: Legend Points (center):
https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKENGeoPackage: Legend Polygons:
https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKENGeoPackage: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN