Api session overlay: Difference between revisions
No edit summary Tag: Reverted |
No edit summary Tag: Manual revert |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/overlay | API Endpoint: api/session/overlay | ||
===GET geotiff=== | |||
API Endpoint: api/session/overlay.geotiff | |||
'''Parameters:''' | |||
{|class=wikitable | |||
!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)''': | |||
<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> | |||
===GET asciidxdy=== | |||
API Endpoint: api/session/overlay.asciidxdy | |||
'''Parameters:''' | |||
{|class=wikitable | |||
!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)''': | |||
<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> | |||
===GET asciisquarem=== | |||
API Endpoint: api/session/overlay.asciisquarem | |||
'''Parameters:''' | |||
{|class=wikitable | |||
!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)''': | |||
<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.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.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.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.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.asciisquarem?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | |||
===GET asciisquarecrs=== | |||
API Endpoint: api/session/overlay.asciisquarecrs | |||
'''Parameters:''' | |||
{|class=wikitable | |||
!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)''': | |||
<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)''': | |||
<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)''': | |||
<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''': | |||
<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)''': | |||
<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''': | |||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight> | |||
===GET points=== | ===GET points=== | ||
Latest revision as of 07:33, 7 July 2026
API Endpoint: api/session/overlay
GET geotiff
API Endpoint: api/session/overlay.geotiff
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_TOKENGET asciidxdy
API Endpoint: api/session/overlay.asciidxdy
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.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_TOKENGET asciisquarem
API Endpoint: api/session/overlay.asciisquarem
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.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_TOKENGET asciisquarecrs
API Endpoint: api/session/overlay.asciisquarecrs
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.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_TOKENGET points
API Endpoint: api/session/overlay.points
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
GeoJSON: Legend Points (center):
https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKENGET polygons
API Endpoint: api/session/overlay.polygons
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
GeoJSON: Legend Polygons:
https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKENGET multipolygons
API Endpoint: api/session/overlay.multipolygons
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
GeoJSON: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKENGET gpkgpoints
API Endpoint: api/session/overlay.gpkgpoints
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
GeoPackage: Legend Points (center):
https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKENGET gpkgpolygons
API Endpoint: api/session/overlay.gpkgpolygons
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
GeoPackage: Legend Polygons:
https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKENGET gpkgmultipolygons
API Endpoint: api/session/overlay.gpkgmultipolygons
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
GeoPackage: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN