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
43,073 edits
No edit summary
No edit summary
Line 10: Line 10:


'''Parameters:''' None
'''Parameters:''' None
===getDomainLogo===
Path: web/domain.png
Type: GET
Produces: image/png
'''Parameters:''' None
===getLibJS===
Path: web/{name}.js
Type: GET
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| name
| Path
| String
|
|}
===getPanel===
===getPanel===
Path: web/{path:|index.html|panel.html|panel.body}
Path: web/{path:|index.html|panel.html|panel.body}
Line 129: Line 103:
|}
|}


===get2DMap===
===getLibJS===
Path: web/{a:2dmap.html|map.html}
Path: web/{name}.js


Type: GET
Type: GET
Produces: text/html


'''Parameters:'''
'''Parameters:'''
Line 143: Line 115:
!Default value
!Default value
|-
|-
| webStakeholderID
| name
| Header
| Path
| Integer
| String
|
|-
| base
| Query
| [[WebBaseMap]]
|  
|  
|}
|}
Line 224: Line 191:
|}
|}


===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]]
|
|}
===getDomainLogo===
Path: web/domain.png
Type: GET
Produces: image/png
'''Parameters:''' None
==ActionMenu==
==ActionMenu==
===getMeasure===
===getMeasure===
Line 260: Line 260:
|}
|}


===getActionMenuActions===
===getActionMenus===
Path: web/actionmenuactions.geojson
Path: web/actionmenus.geojson


Type: GET
Type: GET
Line 283: Line 283:
| String
| String
| EPSG:3857
| EPSG:3857
|-
| id
| Query
| Integer
| -1
|}
|}


===getActionMenus===
===getActionMenuActions===
Path: web/actionmenus.geojson
Path: web/actionmenuactions.geojson


Type: GET
Type: GET
Line 313: Line 308:
| String
| String
| EPSG:3857
| EPSG:3857
|-
| id
| Query
| Integer
| -1
|}
|}


Line 351: Line 351:


==Indicator==
==Indicator==
===getIndicator===
===getIndicators===
Path: web/indicator.html
Path: web/indicators.geojson


Type: GET
Type: GET


Produces: text/html
Produces: application/json


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


===getIndicators===
===getIndicator===
Path: web/indicators.geojson
Path: web/indicator.html


Type: GET
Type: GET


Produces: application/json
Produces: text/html


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


==Label==
==Label==
===getNeighborhoods===
===getStreets===
Path: web/neighborhoods.geojson
Path: web/streets.geojson


Type: GET
Type: GET
Line 432: Line 432:
|}
|}


===getStreets===
===getNeighborhoods===
Path: web/streets.geojson
Path: web/neighborhoods.geojson


Type: GET
Type: GET
Line 506: Line 506:
|}
|}


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


Type: GET
Type: GET
Line 518: Line 518:
!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
|  
|  
|-
|-
| id
| layer
| Query
| Query
| Integer
| String
|  
|  
|-
|-
| overlay
| timeframe
| Query
| int
| 0
|-
| crs
| Query
| String
| EPSG:3857
|-
| forcexy
| Query
| Query
| Integer
| Boolean
|  
|  
|-
|-
Line 538: Line 573:
| MAQUETTE
| MAQUETTE
|-
|-
| width
| x
| Query
| Query
| int
| int
| 256
| -1
|-
|-
| height
| y
| Query
| Query
| int
| int
| 256
| -1
|-
|-
| offset
| i
| Query
| Query
| float
| int
| 0
| -1
|-
|-
| timeframe
| j
| Query
| Query
| int
| int
| 0
| -1
|-
| bgcolor
| Query
| String
|
|-
| format
| Query
| String
|
|-
| info_format
| Query
| String
| text/plain
|-
|-
| worlddatum
| walled
| Query
| Query
| boolean
| boolean
| false
| true
|-
|-
| decimation
| styles
| Query
| Query
| int
| String
| 16
|  
|}
|}


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


Type: GET
Type: GET
Line 585: Line 635:
| String
| String
|  
|  
|-
| bbox
| Query
| String
|
|-
| crs
| Query
| String
| EPSG:3857
|-
|-
| id
| id
Line 620: Line 660:
| float
| float
| 0
| 0
|-
| flipY
| Query
| boolean
| false
|-
|-
| worlddatum
| worlddatum
Line 630: Line 675:
| int
| int
| 16
| 16
|}
===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
|-
| buildings
| Query
| boolean
| false
|}
|}


Line 730: Line 745:
|}
|}


===getWater===
===postAvgHeight===
Path: web/water.{format}
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
|-
| buildings
| Query
| boolean
| false
|}
 
===getFlood===
Path: web/flood.{format}


Type: GET
Type: GET
Line 748: Line 793:
|-
|-
| id
| id
| Query
| Integer
|
|-
| overlay
| Query
| Query
| Integer
| Integer
Line 772: Line 822:
| 0
| 0
|-
|-
| flipY
| timeframe
| Query
| Query
| boolean
| int
| false
| 0
|-
|-
| worlddatum
| worlddatum
Line 788: Line 838:
|}
|}


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


Type: GET
Type: GET
Line 800: Line 850:
!Default value
!Default value
|-
|-
| webStakeholderID
| format
| Header
| Path
| Integer
| String
|  
|  
|-
| request
| Query
| [[Request]]
| GetCapabilities
|-
|-
| bbox
| bbox
Line 814: Line 859:
| String
| String
|  
|  
|-
| width
| Query
| int
| 256
|-
| height
| Query
| int
| 256
|-
| layers
| Query
| String
|
|-
| layer
| Query
| String
|
|-
| timeframe
| Query
| int
| 0
|-
|-
| crs
| crs
Line 845: Line 865:
| EPSG:3857
| EPSG:3857
|-
|-
| forcexy
| id
| Query
| Query
| Boolean
| Integer
|  
|  
|-
|-
Line 855: Line 875:
| 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
|}
|}


Line 1,052: Line 1,052:


==Popup==
==Popup==
===getPopupClusters===
===getPopup===
Path: web/popupclusters.geojson
Path: web/popup.html


Type: GET
Type: GET


Produces: application/json
Produces: text/html


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


Line 1,112: Line 1,117:
|}
|}


===getPopup===
===getPopupClusters===
Path: web/popup.html
Path: web/popupclusters.geojson


Type: GET
Type: GET


Produces: text/html
Produces: application/json


'''Parameters:'''
'''Parameters:'''
Line 1,131: Line 1,136:
|  
|  
|-
|-
| stakeholderid
| bbox
| Query
| Query
| Integer
| String
| -1
|  
|-
|-
| id
| crs
| Query
| Query
| Integer
| String
| -1
| EPSG:3857
|-
| css
| Query
| Boolean
|  
|}
|}


Revision as of 14:43, 8 June 2026

General path: web/

Web

getKeepAlive

Path: web/resettimeout

Type: GET

Produces: text/plain

Parameters: None

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

getCSS

Path: web/{name}.css

Type: GET

Produces: text/css

Parameters:

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

getLibJS

Path: web/{name}.js

Type: GET

Parameters:

Name Location Type Default value
name Path String

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

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

Path: web/domain.png

Type: GET

Produces: image/png

Parameters: None

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

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

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

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 -1
css Query boolean true
maptype Query Map Type MAQUETTE

Label

getStreets

Path: web/streets.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
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

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

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

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

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

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

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

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

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

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

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