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
===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 110: Line 60:
|}
|}


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


Type: GET
Type: GET


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


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


===postEventForm===
===getCSS===
Path: web/event/{eventclass}/{eventname}
Path: web/{name}.css
 
Type: GET


Type: POST
Produces: text/css


'''Parameters:'''
'''Parameters:'''
Line 142: Line 99:
!Default value
!Default value
|-
|-
| webStakeholderID
| name
| Header
| Integer
|
|-
| eventclass
| Path
| Path
| String
| String
|  
|  
|-
|-
| eventname
| replacetoken
| Path
| Query
| String
| boolean
|  
| true
|}
|}


===getDomainLogo===
Path: web/domain.png
Type: GET
Produces: image/png
'''Parameters:''' None
===getLibJS===
===getLibJS===
Path: web/{name}.js
Path: web/{name}.js
Line 184: Line 128:
|}
|}


===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 224: Line 176:
|}
|}


==ActionMenu==
===getAssets===
===getActionMenus===
Path: web/assets/{path : [a-zA-Z0-9/._-]+}
Path: web/actionmenus.geojson


Type: GET
Type: GET


Produces: application/json
Produces: image/png , image/jpeg
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| path
| Path
| String
|
|}
 
===postEventForm===
Path: web/event/{eventclass}/{eventname}
 
Type: POST


'''Parameters:'''
'''Parameters:'''
Line 244: Line 213:
|  
|  
|-
|-
| crs
| eventclass
| Query
| Path
| String
|
|-
| eventname
| Path
| String
| String
| EPSG:3857
|  
|}
|}


===getCinematic===
==ActionMenu==
Path: web/cinematic.geojson
===getMeasure===
Path: web/measure.geojson


Type: GET
Type: GET
Line 285: Line 260:
|}
|}


===getMeasure===
===getActionMenuActions===
Path: web/measure.geojson
Path: web/actionmenuactions.geojson


Type: GET
Type: GET
Line 309: Line 284:
| EPSG:3857
| EPSG:3857
|-
|-
| forcexy
| id
| Query
| Query
| Boolean
| Integer
| -1
|}
 
===getActionMenus===
Path: web/actionmenus.geojson
 
Type: GET
 
Produces: application/json
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|  
|  
|-
|-
| id
| crs
| Query
| Query
| Integer
| String
| -1
| EPSG:3857
|}
|}


===getActionMenuActions===
===getCinematic===
Path: web/actionmenuactions.geojson
Path: web/cinematic.geojson


Type: GET
Type: GET
Line 343: Line 338:
| String
| String
| EPSG:3857
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|
|-
|-
| id
| id
Line 412: Line 412:


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


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


===getNeighborhoods===
===getStreets===
Path: web/neighborhoods.geojson
Path: web/streets.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
|-
| 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
|}
|}


===getTerrain===
===getFlood===
Path: web/terrain.{format}
Path: web/flood.{format}


Type: GET
Type: GET
Line 586: Line 666:
|  
|  
|-
|-
| bbox
| id
| Query
| Query
| String
| Integer
|  
|  
|-
|-
| crs
| overlay
| Query
| String
| EPSG:3857
|-
| id
| Query
| Query
| Integer
| Integer
Line 619: Line 694:
| Query
| Query
| float
| float
| 0
|-
| timeframe
| Query
| int
| 0
| 0
|-
|-
Line 632: Line 712:
|}
|}


===getTerrainTile===
===getWater===
Path: web/terrain/{z}/{x}/{y}.{format}
Path: web/water.{format}


Type: GET
Type: GET
Line 649: Line 729:
|  
|  
|-
|-
| z
| id
| Path
| Query
| int
| Integer
|  
|  
|-
|-
| x
| maptype
| Path
| int
|
|-
| y
| Path
| int
|
|-
| v
| Query
| Query
| String
| [[Map Type]]
|  
| MAQUETTE
|-
|-
| width
| width
Line 684: Line 754:
| 0
| 0
|-
|-
| maptype
| flipY
| Query
| Query
| [[Map Type]]
| boolean
| MAQUETTE
| false
|-
|-
| worlddatum
| worlddatum
Line 700: Line 770:
|}
|}


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


Type: GET
Type: GET
Line 716: Line 786:
| String
| String
|  
|  
|-
| bbox
| Query
| String
|
|-
| crs
| Query
| String
| EPSG:3857
|-
|-
| id
| id
Line 741: Line 821:
| float
| float
| 0
| 0
|-
| flipY
| Query
| boolean
| false
|-
|-
| worlddatum
| worlddatum
Line 758: Line 833:
|}
|}


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


Type: GET
Type: GET
Line 770: Line 845:
!Default value
!Default value
|-
|-
| webStakeholderID
| format
| Header
| Path
| Integer
|
|-
| request
| Query
| [[Request]]
| GetCapabilities
|-
| bbox
| Query
| String
| String
|  
|  
|-
|-
| width
| z
| Query
| Path
| int
| 256
|-
| height
| Query
| int
| int
| 256
|-
| layers
| Query
| String
|  
|  
|-
|-
| layer
| x
| Query
| Path
| String
|
|-
| timeframe
| Query
| int
| int
| 0
|-
| crs
| Query
| String
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|  
|  
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
| x
| Query
| int
| -1
|-
|-
| y
| y
| Query
| Path
| int
| -1
|-
| i
| Query
| int
| int
| -1
|-
| j
| Query
| int
| -1
|-
| bgcolor
| Query
| String
|  
|  
|-
|-
| format
| v
| Query
| Query
| String
| String
|  
|  
|-
|-
| info_format
| width
| Query
| Query
| String
| int
| text/plain
| 256
|-
|-
| walled
| height
| Query
| Query
| boolean
| int
| true
| 256
|-
|-
| styles
| offset
| Query
| Query
| String
| float
|  
| 0
|}
 
===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
| maptype
Line 895: Line 890:
| MAQUETTE
| MAQUETTE
|-
|-
| buildings
| worlddatum
| Query
| Query
| boolean
| boolean
| false
| false
|-
| decimation
| Query
| int
| 16
|}
|}


Line 1,087: Line 1,087:
|}
|}


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


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


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


Type: GET
Type: GET

Revision as of 09:53, 10 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

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

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

Path: web/domain.png

Type: GET

Produces: image/png

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

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

postEventForm

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

Type: POST

Parameters:

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

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

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

Indicator

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

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

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

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

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

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

getOverlays

Path: web/overlays.geojson

Type: GET

Produces: application/json

Parameters:

Name Location Type Default value
webStakeholderID Header Integer
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 -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=85305"