Api session viewers: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
42,421 edits
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/viewers
API Endpoint: api/session/viewers
===GET 2dmap.html===
API Endpoint: web/2dmap.html
Produces: text/html
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| base
| Query
| [[WebBaseMap]]
|
|}
===='''Examples====
'''2D Map (OpenLayers)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/2dmap.html?token=WEB_TOKEN</syntaxhighlight>
===GET 3dmap.html===
API Endpoint: web/3dmap.html
Produces: text/html
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| overlay
| Query
| Integer
|
|-
| base
| Query
| [[WebBaseMap]]
|
|-
| style
| Query
| [[WebModelStyle]]
|
|-
| shadow
| Query
| Boolean
|
|-
| texture
| Query
| [[TextureSize]]
|
|-
| spacing
| Query
| Double
|
|}
===='''Examples====
'''3D Map (Cesium)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dmap.html?token=WEB_TOKEN</syntaxhighlight>
===GET tileset.json===
API Endpoint: web/3dtiles/tileset.json
Produces: application/json
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| style
| Query
| [[WebModelStyle]]
| WHITE
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| texture
| Query
| [[TextureSize]]
| MEDIUM
|-
| spacing
| Query
| double
| 2.0
|-
| bbox
| Query
| String
|
|-
| crs
| Query
| String
| LOCAL
|}
===='''Examples====
'''3D Tiles (buildings)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN</syntaxhighlight>
'''Basic endpoint''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN</syntaxhighlight>
'''Query for MapType: CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?maptype=CURRENT&token=WEB_TOKEN</syntaxhighlight>
'''Model Style: WHITE''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?style=WHITE&token=WEB_TOKEN</syntaxhighlight>
'''Model Style: COLORED''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?style=COLORED&token=WEB_TOKEN</syntaxhighlight>
'''Texture Size (smaller reduces memory): SMALL''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?texture=SMALL&token=WEB_TOKEN</syntaxhighlight>
'''Texture Size (smaller reduces memory): MEDIUM''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?texture=MEDIUM&token=WEB_TOKEN</syntaxhighlight>
'''Texture Size (smaller reduces memory): LARGE''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?texture=LARGE&token=WEB_TOKEN</syntaxhighlight>
'''Model Spacing (larger means e.g. trees further apart): 1.0''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?spacing=1.0&token=WEB_TOKEN</syntaxhighlight>
'''Model Spacing (larger means e.g. trees further apart): 2.0''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?spacing=2.0&token=WEB_TOKEN</syntaxhighlight>
'''Model Spacing (larger means e.g. trees further apart): 4.0''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?spacing=4.0&token=WEB_TOKEN</syntaxhighlight>
===GET terrain/{z}/{x}/{y}.{format}===
API Endpoint: web/terrain/{z}/{x}/{y}.{format}
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| format
| Path
| String
|
|-
| z
| Path
| int
|
|-
| x
| Path
| int
|
|-
| y
| Path
| int
|
|-
| v
| Query
| String
|
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| offset
| Query
| float
| 0
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| int
| 16
|}
===='''Examples====
'''Terrain Tiles (elevation)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain/3/2/1.bin?token=WEB_TOKEN</syntaxhighlight>
'''Query Tiling endpoint: /terrain/{y}/{x}/{y}.txt''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain/3/2/1.txt?token=WEB_TOKEN</syntaxhighlight>
===GET wms===
API Endpoint: web/wms
'''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====
'''WMS''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&token=WEB_TOKEN</syntaxhighlight>


===GET indicators.geojson===
===GET indicators.geojson===
Line 204: Line 553:
'''Scenarios''':
'''Scenarios''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/scenarios.geojson?token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/scenarios.geojson?token=WEB_TOKEN</syntaxhighlight>
===GET terrain.{format}===
API Endpoint: web/terrain.{format}
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| format
| Path
| String
|
|-
| bbox
| Query
| String
|
|-
| crs
| Query
| String
| EPSG:3857
|-
| id
| Query
| Integer
|
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| offset
| Query
| float
| 0
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| int
| 16
|}
===='''Examples====
'''Basic Query''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?&token=WEB_TOKEN</syntaxhighlight>
'''Query with BBOX (EPSG:3857)''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?&crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=WEB_TOKEN</syntaxhighlight>
'''Query with width=16 and height=16''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?width=16&height=16&token=WEB_TOKEN</syntaxhighlight>
'''Query for MapType: CURRENT''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?maptype=CURRENT&token=WEB_TOKEN</syntaxhighlight>
'''Query with World instead of CRS Datum''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?worlddatum=true&token=WEB_TOKEN</syntaxhighlight>
===GET water.{format}===
API Endpoint: web/water.{format}
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| format
| Path
| String
|
|-
| id
| Query
| Integer
|
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| offset
| Query
| float
| 0
|-
| flipY
| Query
| boolean
| false
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| int
| 16
|}
===='''Examples====
'''Query Water instead of Terrain elevation''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/water.txt?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>


{{article end
{{article end

Revision as of 14:12, 15 June 2026

API Endpoint: api/session/viewers

GET 2dmap.html

API Endpoint: web/2dmap.html

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
base Query WebBaseMap

Examples

2D Map (OpenLayers): 

https://engine.tygron.com/web/2dmap.html?token=WEB_TOKEN

GET 3dmap.html

API Endpoint: web/3dmap.html

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
overlay Query Integer
base Query WebBaseMap
style Query WebModelStyle
shadow Query Boolean
texture Query TextureSize
spacing Query Double

Examples

3D Map (Cesium): 

https://engine.tygron.com/web/3dmap.html?token=WEB_TOKEN

GET tileset.json

API Endpoint: web/3dtiles/tileset.json

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
style Query WebModelStyle WHITE
maptype Query Map Type MAQUETTE
texture Query TextureSize MEDIUM
spacing Query double 2.0
bbox Query String
crs Query String LOCAL

Examples

3D Tiles (buildings): 

https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN

Basic endpoint: 

https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN

Query for MapType: CURRENT: 

https://engine.tygron.com/web/3dtiles/tileset.json?maptype=CURRENT&token=WEB_TOKEN

Model Style: WHITE: 

https://engine.tygron.com/web/3dtiles/tileset.json?style=WHITE&token=WEB_TOKEN

Model Style: COLORED: 

https://engine.tygron.com/web/3dtiles/tileset.json?style=COLORED&token=WEB_TOKEN

Texture Size (smaller reduces memory): SMALL: 

https://engine.tygron.com/web/3dtiles/tileset.json?texture=SMALL&token=WEB_TOKEN

Texture Size (smaller reduces memory): MEDIUM: 

https://engine.tygron.com/web/3dtiles/tileset.json?texture=MEDIUM&token=WEB_TOKEN

Texture Size (smaller reduces memory): LARGE: 

https://engine.tygron.com/web/3dtiles/tileset.json?texture=LARGE&token=WEB_TOKEN

Model Spacing (larger means e.g. trees further apart): 1.0: 

https://engine.tygron.com/web/3dtiles/tileset.json?spacing=1.0&token=WEB_TOKEN

Model Spacing (larger means e.g. trees further apart): 2.0: 

https://engine.tygron.com/web/3dtiles/tileset.json?spacing=2.0&token=WEB_TOKEN

Model Spacing (larger means e.g. trees further apart): 4.0: 

https://engine.tygron.com/web/3dtiles/tileset.json?spacing=4.0&token=WEB_TOKEN

GET terrain/{z}/{x}/{y}.{format}

API Endpoint: web/terrain/{z}/{x}/{y}.{format}

Parameters:

Name Location Type Default value
format Path String
z Path int
x Path int
y Path int
v Query String
width Query int 256
height Query int 256
offset Query float 0
maptype Query Map Type MAQUETTE
worlddatum Query boolean false
decimation Query int 16

Examples

Terrain Tiles (elevation): 

https://engine.tygron.com/web/terrain/3/2/1.bin?token=WEB_TOKEN

Query Tiling endpoint: /terrain/{y}/{x}/{y}.txt: 

https://engine.tygron.com/web/terrain/3/2/1.txt?token=WEB_TOKEN

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

WMS: 

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

GET indicators.geojson

API Endpoint: web/indicators.geojson

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857

Examples

Indicators: 

https://engine.tygron.com/web/indicators.geojson?token=WEB_TOKEN

GET overlays.geojson

API Endpoint: web/overlays.geojson

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857

Examples

Overlays: 

https://engine.tygron.com/web/overlays.geojson?token=WEB_TOKEN

GET neighborhoods.geojson

API Endpoint: web/neighborhoods.geojson

Produces: application/json

Parameters:

Name Location Type Default value
crs Query String EPSG:3857

Examples

Neighborhoods: 

https://engine.tygron.com/web/neighborhoods.geojson?token=WEB_TOKEN

GET actionmenus.geojson

API Endpoint: web/actionmenus.geojson

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857

Examples

Actions: 

https://engine.tygron.com/web/actionmenus.geojson?token=WEB_TOKEN

GET popups.geojson

API Endpoint: web/popups.geojson

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
bbox Query String
crs Query String EPSG:3857

Examples

Popups: 

https://engine.tygron.com/web/popups.geojson?token=WEB_TOKEN

GET lines.geojson

API Endpoint: web/lines.geojson

Produces: application/json

Parameters:

Name Location Type Default value
bbox Query String
minlength Query Double
maxlength Query Double
type Query Net Type
crs Query String EPSG:3857

Examples

Lines: 

https://engine.tygron.com/web/lines.geojson?token=WEB_TOKEN

GET scenarios.geojson

API Endpoint: web/scenarios.geojson

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857

Examples

Scenarios: 

https://engine.tygron.com/web/scenarios.geojson?token=WEB_TOKEN

GET terrain.{format}

API Endpoint: web/terrain.{format}

Parameters:

Name Location Type Default value
format Path String
bbox Query String
crs Query String EPSG:3857
id Query Integer
maptype Query Map Type MAQUETTE
width Query int 256
height Query int 256
offset Query float 0
worlddatum Query boolean false
decimation Query int 16

Examples

Basic Query: 

https://engine.tygron.com/web/terrain.txt?&token=WEB_TOKEN

Query with BBOX (EPSG:3857): 

https://engine.tygron.com/web/terrain.txt?&crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=WEB_TOKEN

Query with width=16 and height=16: 

https://engine.tygron.com/web/terrain.txt?width=16&height=16&token=WEB_TOKEN

Query for MapType: CURRENT: 

https://engine.tygron.com/web/terrain.txt?maptype=CURRENT&token=WEB_TOKEN

Query with World instead of CRS Datum: 

https://engine.tygron.com/web/terrain.txt?worlddatum=true&token=WEB_TOKEN

GET water.{format}

API Endpoint: web/water.{format}

Parameters:

Name Location Type Default value
format Path String
id Query Integer
maptype Query Map Type MAQUETTE
width Query int 256
height Query int 256
offset Query float 0
flipY Query boolean false
worlddatum Query boolean false
decimation Query int 16

Examples

Query Water instead of Terrain elevation: 

https://engine.tygron.com/web/water.txt?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

See also

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