Web Endpoint: 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
43,073 edits
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
General path: web/
API Endpoint: web/


==Web==
===getKeepAlive===
===getKeepAlive===
Path: web/resettimeout
Path: web/resettimeout
Line 10: Line 9:


'''Parameters:''' None
'''Parameters:''' None
===getCSS===
Path: web/{name}.css
Type: GET
Produces: text/css
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| name
| Path
| String
|
|-
| replacetoken
| Query
| boolean
| true
|}
===get2DMap===
Path: web/{a:2dmap.html|map.html}
Type: GET
Produces: text/html
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| base
| Query
| [[WebBaseMap]]
|
|}
===get3DMap===
===get3DMap===
Path: web/{a:3dmap.html|cesium.html}
Path: web/{a:3dmap.html|cesium.html}
Line 60: Line 109:
|}
|}


===get2DMap===
===getAssets===
Path: web/{a:2dmap.html|map.html}
Path: web/assets/{path : [a-zA-Z0-9/._-]+}


Type: GET
Type: GET


Produces: text/html
Produces: image/png , image/jpeg


'''Parameters:'''
'''Parameters:'''
Line 74: Line 123:
!Default value
!Default value
|-
|-
| webStakeholderID
| path
| Header
| Path
| Integer
| String
|
|-
| base
| Query
| [[WebBaseMap]]
|  
|  
|}
|}


===getCSS===
===getDomainLogo===
Path: web/{name}.css
Path: web/domain.png


Type: GET
Type: GET


Produces: text/css
Produces: image/png
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| name
| Path
| String
|
|-
| replacetoken
| Query
| boolean
| true
|}


'''Parameters:''' None
===getLibJS===
===getLibJS===
Path: web/{name}.js
Path: web/{name}.js
Line 128: Line 155:
|}
|}


===getDomainLogo===
Path: web/domain.png
Type: GET
Produces: image/png
'''Parameters:''' None
===getPanel===
===getPanel===
Path: web/{path:|index.html|panel.html|panel.body}
Path: web/{path:|index.html|panel.html|panel.body}
Line 173: Line 192:
| Query
| Query
| Boolean
| Boolean
|
|}
===getAssets===
Path: web/assets/{path : [a-zA-Z0-9/._-]+}
Type: GET
Produces: image/png , image/jpeg
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| path
| Path
| String
|  
|  
|}
|}
Line 224: Line 223:
|}
|}


==ActionMenu==
===getMeasure===
===getMeasure===
Path: web/measure.geojson
Path: web/measure.geojson
Line 350: Line 348:
|}
|}


==Indicator==
===getIndicator===
===getIndicator===
Path: web/indicator.html
Path: web/indicator.html
Line 411: Line 408:
|}
|}


==Label==
===getNeighborhoods===
===getNeighborhoods===
Path: web/neighborhoods.geojson
Path: web/neighborhoods.geojson
Line 452: Line 448:
|}
|}


==Map==
===getDirection===
===getDirection===
Path: web/direction.{format}
Path: web/direction.{format}
Line 506: Line 501:
|}
|}


===getWMS===
===getFlood===
Path: web/wms
Path: web/flood.{format}


Type: GET
Type: GET
Line 518: Line 513:
!Default value
!Default value
|-
|-
| webStakeholderID
| format
| Header
| Path
| String
|
|-
| id
| Query
| Integer
| Integer
|  
|  
|-
|-
| request
| overlay
| Query
| Query
| [[Request]]
| Integer
| GetCapabilities
|  
|-
|-
| bbox
| maptype
| Query
| Query
| String
| [[Map Type]]
|  
| MAQUETTE
|-
|-
| width
| width
Line 543: Line 543:
| 256
| 256
|-
|-
| layers
| offset
| Query
| float
| 0
|-
| timeframe
| Query
| int
| 0
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| Query
| int
| 16
|}
===getTerrain===
Path: web/terrain.{format}
Type: GET
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| format
| Path
| String
| String
|  
|  
|-
|-
| layer
| bbox
| Query
| Query
| String
| String
|  
|  
|-
| timeframe
| Query
| int
| 0
|-
|-
| crs
| crs
Line 563: Line 591:
| EPSG:3857
| EPSG:3857
|-
|-
| forcexy
| id
| Query
| Query
| Boolean
| Integer
|  
|  
|-
|-
Line 573: Line 601:
| MAQUETTE
| MAQUETTE
|-
|-
| x
| width
| Query
| Query
| int
| int
| -1
| 256
|-
|-
| y
| height
| Query
| Query
| int
| int
| -1
| 256
|-
|-
| i
| offset
| Query
| Query
| int
| float
| -1
| 0
|-
|-
| j
| worlddatum
| Query
| int
| -1
|-
| bgcolor
| Query
| String
|
|-
| format
| Query
| String
|
|-
| info_format
| Query
| String
| text/plain
|-
| walled
| Query
| Query
| boolean
| boolean
| true
| false
|-
|-
| styles
| decimation
| Query
| Query
| String
| int
|  
| 16
|}
|}


===postAvgHeight===
===getTerrainTile===
Path: web/avgheight.number
Path: web/terrain/{z}/{x}/{y}.{format}
 
Type: POST
 
Produces: application/json , application/octet-stream
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| f
| Query
| [[Format]]
| JSON
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| buildings
| Query
| boolean
| false
|}
 
===getFlood===
Path: web/flood.{format}


Type: GET
Type: GET
Line 666: Line 644:
|  
|  
|-
|-
| id
| z
| Query
| Path
| Integer
| int
|
|-
| x
| Path
| int
|  
|  
|-
|-
| overlay
| y
| Query
| Path
| Integer
| int
|  
|  
|-
|-
| maptype
| v
| Query
| Query
| [[Map Type]]
| String
| MAQUETTE
|  
|-
|-
| width
| width
Line 696: Line 679:
| 0
| 0
|-
|-
| timeframe
| maptype
| Query
| Query
| int
| [[Map Type]]
| 0
| MAQUETTE
|-
|-
| worlddatum
| worlddatum
Line 770: Line 753:
|}
|}


===getTerrain===
===getWMS===
Path: web/terrain.{format}
Path: web/wms


Type: GET
Type: GET
Line 782: Line 765:
!Default value
!Default value
|-
|-
| format
| webStakeholderID
| Path
| Header
| String
| Integer
|  
|  
|-
|-
| bbox
| request
| Query
| Query
| String
| [[Request]]
|  
| GetCapabilities
|-
|-
| crs
| bbox
| Query
| Query
| String
| String
| EPSG:3857
|-
| id
| Query
| Integer
|  
|  
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
|-
| width
| width
Line 817: Line 790:
| 256
| 256
|-
|-
| offset
| layers
| Query
| Query
| float
| String
| 0
|  
|-
|-
| worlddatum
| layer
| Query
| Query
| boolean
| String
| false
|  
|-
|-
| decimation
| timeframe
| Query
| Query
| int
| int
| 16
| 0
|}
 
===getTerrainTile===
Path: web/terrain/{z}/{x}/{y}.{format}
 
Type: GET
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|-
| format
| crs
| Path
| Query
| String
| String
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|  
|  
|-
|-
| z
| maptype
| Path
| Query
| int
| [[Map Type]]
|  
| MAQUETTE
|-
|-
| x
| x
| Path
| Query
| int
| int
|  
| -1
|-
|-
| y
| y
| Path
| Query
| int
| -1
|-
| i
| Query
| int
| -1
|-
| j
| Query
| int
| int
| -1
|-
| bgcolor
| Query
| String
|  
|  
|-
|-
| v
| format
| Query
| Query
| String
| String
|  
|  
|-
|-
| width
| info_format
| Query
| String
| text/plain
|-
| walled
| Query
| Query
| int
| boolean
| 256
| true
|-
|-
| height
| styles
| Query
| Query
| int
| String
| 256
|  
|}
 
'''GET 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>
 
===postAvgHeight===
Path: web/avgheight.number
 
Type: POST
 
Produces: application/json , application/octet-stream
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|-
| offset
| f
| Query
| Query
| float
| [[Format]]
| 0
| JSON
|-
|-
| maptype
| maptype
Line 890: Line 909:
| MAQUETTE
| MAQUETTE
|-
|-
| worlddatum
| buildings
| Query
| Query
| boolean
| boolean
| false
| false
|-
| decimation
| Query
| int
| 16
|}
|}


==Net==
===getLines===
===getLines===
Path: web/lines.geojson
Path: web/lines.geojson
Line 942: Line 955:
|}
|}


==Overlay==
===getOverlays===
Path: web/overlays.geojson
 
Type: GET
 
Produces: application/json
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| crs
| Query
| String
| EPSG:3857
|}
 
===getOverlayImage===
===getOverlayImage===
Path: web/overlay.png
Path: web/overlay.png
Line 1,026: Line 1,063:
|}
|}


===getOverlays===
Path: web/overlays.geojson
Type: GET
Produces: application/json
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| crs
| Query
| String
| EPSG:3857
|}
==Popup==
===getPopup===
===getPopup===
Path: web/popup.html
Path: web/popup.html
Line 1,087: Line 1,098:
|}
|}


===getPopups===
===getPopupClusters===
Path: web/popups.geojson
Path: web/popupclusters.geojson


Type: GET
Type: GET
Line 1,117: Line 1,128:
|}
|}


===getPopupClusters===
===getPopups===
Path: web/popupclusters.geojson
Path: web/popups.geojson


Type: GET
Type: GET
Line 1,147: Line 1,158:
|}
|}


==Scenario==
===getScenarios===
===getScenarios===
Path: web/scenarios.geojson
Path: web/scenarios.geojson
Line 1,173: Line 1,183:
|}
|}


==Version==
===getVersion===
===getVersion===
Path: web/version.json
Path: web/version.json

Latest revision as of 15:46, 10 June 2026

API Endpoint: web/

getKeepAlive

Path: web/resettimeout

Type: GET

Produces: text/plain

Parameters: None

getCSS

Path: web/{name}.css

Type: GET

Produces: text/css

Parameters:

Name Location Type Default value
name Path String
replacetoken Query boolean true

get2DMap

Path: web/{a:2dmap.html|map.html}

Type: GET

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
base Query WebBaseMap

get3DMap

Path: web/{a:3dmap.html|cesium.html}

Type: GET

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

getAssets

Path: web/assets/{path : [a-zA-Z0-9/._-]+}

Type: GET

Produces: image/png , image/jpeg

Parameters:

Name Location Type Default value
path Path String

Path: web/domain.png

Type: GET

Produces: image/png

Parameters: None

getLibJS

Path: web/{name}.js

Type: GET

Parameters:

Name Location Type Default value
name Path String

getPanel

Path: web/{path:|index.html|panel.html|panel.body}

Type: GET

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
stakeholderid Query Integer -1
path Path String
id Query Integer -1
css Query Boolean

postEventForm

Path: web/event/{eventclass}/{eventname}

Type: POST

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
eventclass Path String
eventname Path String

getMeasure

Path: web/measure.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857
forcexy Query Boolean
id Query Integer -1

getActionMenuActions

Path: web/actionmenuactions.geojson

Type: GET

Produces: application/json

Parameters:

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

getActionMenus

Path: web/actionmenus.geojson

Type: GET

Produces: application/json

Parameters:

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

getCinematic

Path: web/cinematic.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
crs Query String EPSG:3857
forcexy Query Boolean
id Query Integer -1

getIndicator

Path: web/indicator.html

Type: GET

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
id Query Integer -1
css Query boolean true
maptype Query Map Type MAQUETTE

getIndicators

Path: web/indicators.geojson

Type: GET

Produces: application/json

Parameters:

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

getNeighborhoods

Path: web/neighborhoods.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
crs Query String EPSG:3857

getStreets

Path: web/streets.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
crs Query String EPSG:3857

getDirection

Path: web/direction.{format}

Type: GET

Parameters:

Name Location Type Default value
format Path String
id Query Integer
overlay Query Integer
maptype Query Map Type MAQUETTE
width Query int 256
height Query int 256
timeframe Query int 0
xy Query boolean 0

getFlood

Path: web/flood.{format}

Type: GET

Parameters:

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

getTerrain

Path: web/terrain.{format}

Type: GET

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

getTerrainTile

Path: web/terrain/{z}/{x}/{y}.{format}

Type: GET

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

getWater

Path: web/water.{format}

Type: GET

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

getWMS

Path: web/wms

Type: GET

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

GET 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

postAvgHeight

Path: web/avgheight.number

Type: POST

Produces: application/json , application/octet-stream

Parameters:

Name Location Type Default value
f Query Format JSON
maptype Query Map Type MAQUETTE
buildings Query boolean false

getLines

Path: web/lines.geojson

Type: GET

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

getOverlays

Path: web/overlays.geojson

Type: GET

Produces: application/json

Parameters:

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

getOverlayImage

Path: web/overlay.png

Type: GET

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

getPopup

Path: web/popup.html

Type: GET

Produces: text/html

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
stakeholderid Query Integer -1
id Query Integer -1
css Query Boolean

getPopupClusters

Path: web/popupclusters.geojson

Type: GET

Produces: application/json

Parameters:

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

getPopups

Path: web/popups.geojson

Type: GET

Produces: application/json

Parameters:

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

getScenarios

Path: web/scenarios.geojson

Type: GET

Produces: application/json

Parameters:

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

getVersion

Path: web/version.json

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
links Query String

getItemVersion

Path: web/itemversion.json

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
link Query String
itemid Query String

See also

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