Web Endpoint: 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
39,237 edits
No edit summary
Tag: Reverted
No edit summary
Tag: Reverted
Line 2: Line 2:


==Web==
==Web==
===getCSS===
===getKeepAlive===
Path: web/{name}.css
Path: web/resettimeout


Type: GET
Type: GET


Produces: text/css
Produces: text/plain
 
'''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]]
|
|}


'''Parameters:''' None
===get3DMap===
===get3DMap===
Path: web/{a:3dmap.html|cesium.html}
Path: web/{a:3dmap.html|cesium.html}
Line 188: Line 146:
|}
|}


===getKeepAlive===
Path: web/resettimeout
Type: GET
Produces: text/plain
'''Parameters:''' None
===postEventForm===
===postEventForm===
Path: web/event/{eventclass}/{eventname}
Path: web/event/{eventclass}/{eventname}
Line 224: Line 174:
|}
|}


==ActionMenu==
===getCSS===
===getCinematic===
Path: web/{name}.css
Path: web/cinematic.geojson
 
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
Type: GET


Produces: application/json
Produces: text/html


'''Parameters:'''
'''Parameters:'''
Line 244: Line 218:
|
|
|-
|-
|crs
|base
|Query
|Query
|String
|[[WebBaseMap]]
|EPSG:3857
|-
|forcexy
|Query
|Boolean
|
|
|-
|id
|Query
|Integer
|-1
|}
|}


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


==Indicator==
===getCinematic===
===getIndicator===
Path: web/cinematic.geojson
Path: web/indicator.html


Type: GET
Type: GET


Produces: text/html
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 370: Line 334:
|
|
|-
|-
|id
|crs
|Query
|Query
|Integer
|String
|-1
|EPSG:3857
|-
|-
|css
|forcexy
|Query
|Query
|boolean
|Boolean
|true
|
|-
|-
|maptype
|id
|Query
|Query
|[[Map Type]]
|Integer
|MAQUETTE
|-1
|}
|}


==Indicator==
===getIndicators===
===getIndicators===
Path: web/indicators.geojson
Path: web/indicators.geojson
Line 409: Line 374:
|String
|String
|EPSG:3857
|EPSG:3857
|}
===getIndicator===
Path: web/indicator.html
Type: GET
Produces: text/html
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|webStakeholderID
|Header
|Integer
|
|-
|id
|Query
|Integer
|-1
|-
|css
|Query
|boolean
|true
|-
|maptype
|Query
|[[Map Type]]
|MAQUETTE
|}
|}


Line 506: Line 506:
|}
|}


===postAvgHeight===
===getWater===
Path: web/avgheight.number
Path: web/water.{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 554: Line 524:
|-
|-
|id
|id
|Query
|Integer
|
|-
|overlay
|Query
|Query
|Integer
|Integer
Line 583: Line 548:
|0
|0
|-
|-
|timeframe
|flipY
|Query
|Query
|int
|boolean
|0
|false
|-
|-
|worlddatum
|worlddatum
Line 599: Line 564:
|}
|}


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


Type: GET
Type: GET
Line 611: Line 576:
!Default value
!Default value
|-
|-
|format
|webStakeholderID
|Path
|Header
|Integer
|
|-
|request
|Query
|[[Request]]
|GetCapabilities
|-
|bbox
|Query
|String
|
|-
|width
|Query
|int
|256
|-
|height
|Query
|int
|256
|-
|layers
|Query
|String
|String
|
|
|-
|-
|bbox
|layer
|Query
|Query
|String
|String
|
|
|-
|timeframe
|Query
|int
|0
|-
|-
|crs
|crs
Line 626: Line 621:
|EPSG:3857
|EPSG:3857
|-
|-
|id
|forcexy
|Query
|Query
|Integer
|Boolean
|
|
|-
|-
Line 636: Line 631:
|MAQUETTE
|MAQUETTE
|-
|-
|width
|x
|Query
|int
|-1
|-
|y
|Query
|int
|-1
|-
|i
|Query
|Query
|int
|int
|256
|-1
|-
|-
|height
|j
|Query
|Query
|int
|int
|256
|-1
|-
|bgcolor
|Query
|String
|
|-
|format
|Query
|String
|
|-
|-
|offset
|info_format
|Query
|Query
|float
|String
|0
|text/plain
|-
|-
|worlddatum
|walled
|Query
|Query
|boolean
|boolean
|false
|true
|-
|styles
|Query
|String
|
|}
 
===postAvgHeight===
Path: web/avgheight.number
 
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
|-
|-
|decimation
|buildings
|Query
|Query
|int
|boolean
|16
|false
|}
|}


===getTerrainTile===
===getFlood===
Path: web/terrain/{z}/{x}/{y}.{format}
Path: web/flood.{format}


Type: GET
Type: GET
Line 679: Line 724:
|
|
|-
|-
|z
|id
|Path
|Query
|int
|Integer
|
|
|-
|-
|x
|overlay
|Path
|Query
|int
|Integer
|
|
|-
|-
|y
|maptype
|Path
|int
|
|-
|v
|Query
|Query
|String
|[[Map Type]]
|
|MAQUETTE
|-
|-
|width
|width
Line 714: Line 754:
|0
|0
|-
|-
|maptype
|timeframe
|Query
|Query
|[[Map Type]]
|int
|MAQUETTE
|0
|-
|-
|worlddatum
|worlddatum
Line 730: Line 770:
|}
|}


===getWater===
===getTerrain===
Path: web/water.{format}
Path: web/terrain.{format}


Type: GET
Type: GET
Line 746: Line 786:
|String
|String
|
|
|-
|bbox
|Query
|String
|
|-
|crs
|Query
|String
|EPSG:3857
|-
|-
|id
|id
Line 771: Line 821:
|float
|float
|0
|0
|-
|flipY
|Query
|boolean
|false
|-
|-
|worlddatum
|worlddatum
Line 788: Line 833:
|}
|}


===getWMS===
===getTerrainTile===
Path: web/wms
Path: web/terrain/{z}/{x}/{y}.{format}


Type: GET
Type: GET
Line 800: Line 845:
!Default value
!Default value
|-
|-
|webStakeholderID
|format
|Header
|Path
|Integer
|String
|
|-
|z
|Path
|int
|
|-
|x
|Path
|int
|
|
|-
|-
|request
|y
|Query
|Path
|[[Request]]
|int
|GetCapabilities
|
|-
|-
|bbox
|v
|Query
|Query
|String
|String
Line 825: Line 880:
|256
|256
|-
|-
|layers
|offset
|Query
|Query
|String
|float
|
|-
|layer
|Query
|String
|
|-
|timeframe
|Query
|int
|0
|0
|-
|crs
|Query
|String
|EPSG:3857
|-
|forcexy
|Query
|Boolean
|
|-
|-
|maptype
|maptype
Line 855: Line 890:
|MAQUETTE
|MAQUETTE
|-
|-
|x
|worlddatum
|Query
|Query
|int
|boolean
|-1
|false
|-
|-
|y
|decimation
|Query
|Query
|int
|int
|-1
|16
|-
|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
|
|}
|}


Line 943: Line 943:


==Overlay==
==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,051: Line 1,026:
|}
|}


==Popup==
===getOverlays===
===getPopup===
Path: web/overlays.geojson
Path: web/popup.html


Type: GET
Type: GET


Produces: text/html
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 1,071: Line 1,045:
|
|
|-
|-
|stakeholderid
|crs
|Query
|Query
|Integer
|String
|-1
|EPSG:3857
|-
|id
|Query
|Integer
|-1
|-
|css
|Query
|Boolean
|
|}
|}


==Popup==
===getPopupClusters===
===getPopupClusters===
Path: web/popupclusters.geojson
Path: web/popupclusters.geojson
Line 1,145: Line 1,110:
|String
|String
|EPSG:3857
|EPSG:3857
|}
===getPopup===
Path: web/popup.html
Type: GET
Produces: text/html
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|webStakeholderID
|Header
|Integer
|
|-
|stakeholderid
|Query
|Integer
|-1
|-
|id
|Query
|Integer
|-1
|-
|css
|Query
|Boolean
|
|}
|}


Revision as of 08:05, 3 June 2026

General path: web/

Web

getKeepAlive

Path: web/resettimeout

Type: GET

Produces: text/plain

Parameters: None

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
path Path String
id Query Integer
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

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

ActionMenu

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

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

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

Indicator

getIndicators

Path: web/indicators.geojson

Type: GET

Produces: application/json

Parameters:

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

getIndicator

Path: web/indicator.html

Type: GET

Produces: text/html

Parameters:

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

Label

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

Map

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

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
y Query int
i Query int
j Query int
bgcolor Query String
format Query String
info_format Query String text/plain
walled Query boolean true
styles Query String

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

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

Net

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

Overlay

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

getOverlays

Path: web/overlays.geojson

Type: GET

Produces: application/json

Parameters:

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

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

getPopup

Path: web/popup.html

Type: GET

Produces: text/html

Parameters:

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

Scenario

getScenarios

Path: web/scenarios.geojson

Type: GET

Produces: application/json

Parameters:

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

Version

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=83152"