Api session overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
45,137 edits
No edit summary
No edit summary
Tag: Manual revert
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/overlay.{format}
API Endpoint: api/session/overlay


===GET overlay.{format}===
===GET geotiff===
API Endpoint: api/session/overlay.{format}
API Endpoint: api/session/overlay.geotiff


'''Parameters:'''
'''Parameters:'''
Line 76: Line 76:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
<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)''':
'''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>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&token=API_TOKEN</syntaxhighlight>
Line 94: Line 151:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
<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)''':
'''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>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&token=API_TOKEN</syntaxhighlight>
Line 112: Line 226:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
<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)''':
'''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>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&token=API_TOKEN</syntaxhighlight>
Line 130: Line 301:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>


===GET points===
API Endpoint: api/session/overlay.points
'''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====
'''GeoJSON: Legend Points (center)''':
'''GeoJSON: Legend Points (center)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKEN</syntaxhighlight>


===GET polygons===
API Endpoint: api/session/overlay.polygons
'''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====
'''GeoJSON: Legend Polygons''':
'''GeoJSON: Legend Polygons''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKEN</syntaxhighlight>


===GET multipolygons===
API Endpoint: api/session/overlay.multipolygons
'''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====
'''GeoJSON: Legend MultiPolygons''':
'''GeoJSON: Legend MultiPolygons''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKEN</syntaxhighlight>


===GET gpkgpoints===
API Endpoint: api/session/overlay.gpkgpoints
'''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====
'''GeoPackage: Legend Points (center)''':
'''GeoPackage: Legend Points (center)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKEN</syntaxhighlight>


===GET gpkgpolygons===
API Endpoint: api/session/overlay.gpkgpolygons
'''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====
'''GeoPackage: Legend Polygons''':
'''GeoPackage: Legend Polygons''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKEN</syntaxhighlight>


===GET gpkgmultipolygons===
API Endpoint: api/session/overlay.gpkgmultipolygons
'''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====
'''GeoPackage: Legend MultiPolygons''':
'''GeoPackage: Legend MultiPolygons''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN</syntaxhighlight>

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_TOKEN

Query 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_TOKEN

Query with Scale: 50% (scale=0.5): 

https://engine.tygron.com/api/session/overlay.geotiff?id=ID&scale=0.5&token=API_TOKEN

Query for Timeframe: 0 (timeframe=0: 

https://engine.tygron.com/api/session/overlay.geotiff?id=ID&timeframe=0&token=API_TOKEN

Query for MapType: CURRENT (maptype=CURRENT): 

https://engine.tygron.com/api/session/overlay.geotiff?id=ID&maptype=CURRENT&token=API_TOKEN

Query for export CRS: EPSG:3857: 

https://engine.tygron.com/api/session/overlay.geotiff?id=ID&crs=3857&token=API_TOKEN

GET 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_TOKEN

Query 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_TOKEN

Query with Scale: 50% (scale=0.5): 

https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&scale=0.5&token=API_TOKEN

Query for Timeframe: 0 (timeframe=0: 

https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&timeframe=0&token=API_TOKEN

Query for MapType: CURRENT (maptype=CURRENT): 

https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&maptype=CURRENT&token=API_TOKEN

Query for export CRS: EPSG:3857: 

https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&crs=3857&token=API_TOKEN

GET 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_TOKEN

Query 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_TOKEN

Query with Scale: 50% (scale=0.5): 

https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&scale=0.5&token=API_TOKEN

Query for Timeframe: 0 (timeframe=0: 

https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&timeframe=0&token=API_TOKEN

Query for MapType: CURRENT (maptype=CURRENT): 

https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&maptype=CURRENT&token=API_TOKEN

Query for export CRS: EPSG:3857: 

https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&crs=3857&token=API_TOKEN

GET 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_TOKEN

Query 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_TOKEN

Query with Scale: 50% (scale=0.5): 

https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&scale=0.5&token=API_TOKEN

Query for Timeframe: 0 (timeframe=0: 

https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&timeframe=0&token=API_TOKEN

Query for MapType: CURRENT (maptype=CURRENT): 

https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&maptype=CURRENT&token=API_TOKEN

Query for export CRS: EPSG:3857: 

https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN

GET 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_TOKEN

GET 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_TOKEN

GET 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_TOKEN

GET 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_TOKEN

GET 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_TOKEN

GET 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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_overlay&oldid=89459"