Api session overlays: 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
42,420 edits
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/overlays
API Endpoint: api/session/overlays


===GET overlays.geojson===
===GET wms===
API Endpoint: web/overlays.geojson
API Endpoint: web/wms


Produces: application/json
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| request
| Query
| [[Request]]
| GetCapabilities
|-
| bbox
| Query
| String
|
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| layers
| Query
| String
|
|-
| layer
| Query
| String
|
|-
| timeframe
| Query
| int
| 0
|-
| crs
| Query
| String
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| x
| Query
| int
| -1
|-
| y
| Query
| int
| -1
|-
| i
| Query
| int
| -1
|-
| j
| Query
| int
| -1
|-
| bgcolor
| Query
| String
|
|-
| format
| Query
| String
|
|-
| info_format
| Query
| String
| text/plain
|-
| walled
| Query
| boolean
| true
|-
| styles
| Query
| String
|
|}
 
===='''Examples====
'''Basic Endpoint''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for MapType: CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&maptype=CURRENT&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: INTERPOLATED''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=INTERPOLATED&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: NEAREST''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=NEAREST&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: ARROW''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=ARROW&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: COLOR''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=COLOR&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: FLOAT32''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=FLOAT32&token=WEB_TOKEN</syntaxhighlight>
 
'''Query for Grid Style: DIFFERENCE''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=DIFFERENCE&token=WEB_TOKEN</syntaxhighlight>
 
===GET overlay.{format}===
API Endpoint: api/session/overlay.{format}
 
'''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====
'''IjRff''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
 
'''FKphQ''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
 
'''WUmz3''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
 
'''Height Map''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
 
'''Network Overview''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
 
'''Area''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&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.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 overlay.png===
API Endpoint: web/overlay.png


'''Parameters:'''
'''Parameters:'''
Line 17: Line 244:
| Integer
| Integer
|  
|  
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| bbox
| Query
| String
|
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| id
| Query
| Integer
| -1
|-
| timeframe
| Query
| int
| 0
|-
|-
| crs
| crs
Line 22: Line 279:
| String
| String
| EPSG:3857
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|
|-
| bgcolor
| Query
| String
|
|-
| format
| Query
| String
|
|-
| info_format
| Query
| String
| text/plain
|-
| walled
| Query
| boolean
| true
|-
| styles
| Query
| String
|
|}
|}


===='''Examples====
===='''Examples====
'''Basic Endpoint''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlay.png?id=ID&token=WEB_TOKEN</syntaxhighlight>
'''Query with BBOX (EPSG:3857)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlay.png?id=ID&crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=WEB_TOKEN</syntaxhighlight>
'''Query with width=512 and height=512''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlay.png?id=ID&width=512&height=512&token=WEB_TOKEN</syntaxhighlight>
'''Query for Timeframe: 0''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlay.png?id=ID&timeframe=0&token=WEB_TOKEN</syntaxhighlight>
'''Query for MapType: CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlay.png?id=ID&maptype=CURRENT&token=WEB_TOKEN</syntaxhighlight>
{{article end
{{article end
|seealso=
|seealso=

Latest revision as of 14:01, 15 June 2026

API Endpoint: api/session/overlays

GET wms

API Endpoint: web/wms

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
request Query Request GetCapabilities
bbox Query String
width Query int 256
height Query int 256
layers Query String
layer Query String
timeframe Query int 0
crs Query String EPSG:3857
forcexy Query Boolean
maptype Query Map Type MAQUETTE
x Query int -1
y Query int -1
i Query int -1
j Query int -1
bgcolor Query String
format Query String
info_format Query String text/plain
walled Query boolean true
styles Query String

Examples

Basic Endpoint: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&token=WEB_TOKEN

Query for MapType: CURRENT: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&maptype=CURRENT&token=WEB_TOKEN

Query for Grid Style: INTERPOLATED: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=INTERPOLATED&token=WEB_TOKEN

Query for Grid Style: NEAREST: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=NEAREST&token=WEB_TOKEN

Query for Grid Style: ARROW: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=ARROW&token=WEB_TOKEN

Query for Grid Style: COLOR: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=COLOR&token=WEB_TOKEN

Query for Grid Style: FLOAT32: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=FLOAT32&token=WEB_TOKEN

Query for Grid Style: DIFFERENCE: 

https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&styles=DIFFERENCE&token=WEB_TOKEN

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

IjRff: 

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

FKphQ: 

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

WUmz3: 

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

Height Map: 

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

Network Overview: 

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

Area: 

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

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 overlay.png

API Endpoint: web/overlay.png

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
maptype Query Map Type MAQUETTE
bbox Query String
width Query int 256
height Query int 256
id Query Integer -1
timeframe Query int 0
crs Query String EPSG:3857
forcexy Query Boolean
bgcolor Query String
format Query String
info_format Query String text/plain
walled Query boolean true
styles Query String

Examples

Basic Endpoint: 

https://engine.tygron.com/web/overlay.png?id=ID&token=WEB_TOKEN

Query with BBOX (EPSG:3857): 

https://engine.tygron.com/web/overlay.png?id=ID&crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=WEB_TOKEN

Query with width=512 and height=512: 

https://engine.tygron.com/web/overlay.png?id=ID&width=512&height=512&token=WEB_TOKEN

Query for Timeframe: 0: 

https://engine.tygron.com/web/overlay.png?id=ID&timeframe=0&token=WEB_TOKEN

Query for MapType: CURRENT: 

https://engine.tygron.com/web/overlay.png?id=ID&maptype=CURRENT&token=WEB_TOKEN

See also

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