Api session viewers: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Newer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
42,421 edits
Created page with "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 P..."
 
No edit summary
Line 1: Line 1:
API Endpoint: api/session/viewers
API Endpoint: api/session/viewers


===GET 2dmap.html===
===GET indicators.geojson===
API Endpoint: web/2dmap.html
API Endpoint: web/indicators.geojson


Produces: text/html
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 18: Line 18:
|  
|  
|-
|-
| base
| crs
| Query
| Query
| [[WebBaseMap]]
| String
|  
| EPSG:3857
|}
|}


===='''Examples====
===='''Examples====
'''2D Map (OpenLayers)''':
'''Indicators''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/2dmap.html?token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/indicators.geojson?token=WEB_TOKEN</syntaxhighlight>


===GET 3dmap.html===
===GET overlays.geojson===
API Endpoint: web/3dmap.html
API Endpoint: web/overlays.geojson


Produces: text/html
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 45: Line 45:
|  
|  
|-
|-
| overlay
| crs
| Query
| Query
| Integer
| String
|
| EPSG:3857
|-
| base
| Query
| [[WebBaseMap]]
|
|-
| style
| Query
| [[WebModelStyle]]
|
|-
| shadow
| Query
| Boolean
|
|-
| texture
| Query
| [[TextureSize]]
|
|-
| spacing
| Query
| Double
|  
|}
|}


===='''Examples====
===='''Examples====
'''3D Map (Cesium)''':
'''Overlays''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dmap.html?token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/overlays.geojson?token=WEB_TOKEN</syntaxhighlight>


===GET tileset.json===
===GET neighborhoods.geojson===
API Endpoint: web/3dtiles/tileset.json
API Endpoint: web/neighborhoods.geojson


Produces: application/json
Produces: application/json
Line 91: Line 66:
!Type
!Type
!Default value
!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
| crs
| Query
| Query
| String
| String
| LOCAL
| EPSG:3857
|}
|}


===='''Examples====
===='''Examples====
'''3D Tiles (buildings)''':
'''Neighborhoods''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/neighborhoods.geojson?token=WEB_TOKEN</syntaxhighlight>


'''Basic endpoint''':
===GET actionmenus.geojson===
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/3dtiles/tileset.json?token=WEB_TOKEN</syntaxhighlight>
API Endpoint: web/actionmenus.geojson


'''Query for MapType: CURRENT''':
Produces: application/json
<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:'''
'''Parameters:'''
Line 172: Line 89:
!Default value
!Default value
|-
|-
| format
| webStakeholderID
| Path
| Header
| String
| Integer
|  
|  
|-
|-
| z
| crs
| Path
| int
|
|-
| x
| Path
| int
|
|-
| y
| Path
| int
|
|-
| v
| Query
| Query
| String
| String
|  
| EPSG:3857
|-
| 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====
===='''Examples====
'''Terrain Tiles (elevation)''':
'''Actions''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain/3/2/1.bin?token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/actionmenus.geojson?token=WEB_TOKEN</syntaxhighlight>


'''Query Tiling endpoint: /terrain/{y}/{x}/{y}.txt''':
===GET popups.geojson===
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain/3/2/1.txt?token=WEB_TOKEN</syntaxhighlight>
API Endpoint: web/popups.geojson


===GET wms===
Produces: application/json
API Endpoint: web/wms


'''Parameters:'''
'''Parameters:'''
Line 249: Line 120:
| Integer
| Integer
|  
|  
|-
| request
| Query
| [[Request]]
| GetCapabilities
|-
|-
| bbox
| bbox
Line 259: Line 125:
| String
| String
|  
|  
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| layers
| Query
| String
|
|-
| layer
| Query
| String
|
|-
| timeframe
| Query
| int
| 0
|-
|-
| crs
| crs
Line 289: Line 130:
| String
| String
| EPSG:3857
| 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====
===='''Examples====
'''WMS''':
'''Popups''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/wms?REQUEST=GetCapabilities&token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/popups.geojson?token=WEB_TOKEN</syntaxhighlight>


===GET terrain.{format}===
===GET lines.geojson===
API Endpoint: web/terrain.{format}
API Endpoint: web/lines.geojson
 
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 359: Line 147:
!Type
!Type
!Default value
!Default value
|-
| format
| Path
| String
|
|-
|-
| bbox
| bbox
Line 370: Line 153:
|  
|  
|-
|-
| crs
| minlength
| Query
| String
| EPSG:3857
|-
| id
| Query
| Query
| Integer
| Double
|  
|  
|-
|-
| maptype
| maxlength
| Query
| Query
| [[Map Type]]
| Double
| MAQUETTE
|  
|-
|-
| width
| type
| Query
| Query
| int
| [[Net Type]]
| 256
|  
|-
|-
| height
| crs
| Query
| Query
| int
| String
| 256
| EPSG:3857
|-
| offset
| Query
| float
| 0
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| int
| 16
|}
|}


===='''Examples====
===='''Examples====
'''Basic Query''':
'''Lines''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/terrain.txt?&token=WEB_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/lines.geojson?token=WEB_TOKEN</syntaxhighlight>


'''Query with BBOX (EPSG:3857)''':
===GET scenarios.geojson===
<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>
API Endpoint: web/scenarios.geojson


'''Query with width=16 and height=16''':
Produces: application/json
<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:'''
'''Parameters:'''
Line 437: Line 190:
!Default value
!Default value
|-
|-
| format
| webStakeholderID
| Path
| Header
| String
|
|-
| id
| Query
| Integer
| 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
|  
|  
|-
|-
Line 506: Line 199:
| String
| String
| EPSG:3857
| 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====
===='''Examples====
'''IjRff''':
'''Scenarios''':
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.html?id=ID&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/scenarios.geojson?token=WEB_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:05, 15 June 2026

API Endpoint: api/session/viewers

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

See also

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