Web Endpoint: Difference between revisions

← Older edit Newer edit →

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

getDomainLogo

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

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

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

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

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
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
webStakeholderID	Header	Integer
stakeholderid	Query	Integer
id	Query	Integer
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

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

@@ Line 2: / Line 2: @@
 ==Web==
-===postEventForm===
-Path: web/event/{eventclass}/{eventname}
-Type: POST
-'''Parameters:'''
-{|class=wikitable
-!Name
-!Location
-!Type
-!Default value
-|-
-|webStakeholderID
-|Header
-|Integer
-|
-|-
-|eventclass
-|Path
-|String
-|
-|-
-|eventname
-|Path
-|String
-|
-|}
 ===getKeepAlive===
 Path: web/resettimeout
@@ Line 38: / Line 10: @@
 '''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===
 Path: web/{a:3dmap.html|cesium.html}
@@ Line 221: / Line 143: @@
 |Query
 |Boolean
+|
+|}
+===postEventForm===
+Path: web/event/{eventclass}/{eventname}
+Type: POST
+'''Parameters:'''
+{|class=wikitable
+!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:'''
+{|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]]
 |
 |}
 ==ActionMenu==
-===getActionMenuActions===
+===getMeasure===
-Path: web/actionmenuactions.geojson
+Path: web/measure.geojson
 Type: GET
@@ Line 248: / Line 248: @@
 |String
 |EPSG:3857
+|-
+|forcexy
+|Query
+|Boolean
+|
 |-
 |id
@@ Line 255: / Line 260: @@
 |}
-===getActionMenus===
+===getActionMenuActions===
-Path: web/actionmenus.geojson
+Path: web/actionmenuactions.geojson
 Type: GET
@@ Line 278: / Line 283: @@
 |String
 |EPSG:3857
+|-
+|id
+|Query
+|Integer
+|-1
 |}
-===getCinematic===
+===getActionMenus===
-Path: web/cinematic.geojson
+Path: web/actionmenus.geojson
 Type: GET
@@ Line 303: / Line 313: @@
 |String
 |EPSG:3857
-|-
-|forcexy
-|Query
-|Boolean
-|
-|-
-|id
-|Query
-|Integer
-|-1
 |}
-===getMeasure===
+===getCinematic===
-Path: web/measure.geojson
+Path: web/cinematic.geojson
 Type: GET
@@ Line 504: / Line 504: @@
 |boolean
 |0
+|}
+===getFlood===
+Path: web/flood.{format}
+Type: GET
+'''Parameters:'''
+{|class=wikitable
+!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:'''
+{|class=wikitable
+!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
 |}
@@ Line 775: / Line 901: @@
 |}
-===getFlood===
+==Net==
-Path: web/flood.{format}
+===getLines===
+Path: web/lines.geojson
 Type: GET
+Produces: application/json
 '''Parameters:'''
@@ Line 787: / Line 916: @@
 !Default value
 |-
-|format
+|bbox
-|Path
+|Query
 |String
 |
 |-
-|id
+|minlength
 |Query
-|Integer
+|Double
 |
 |-
-|overlay
+|maxlength
 |Query
-|Integer
+|Double
 |
 |-
-|maptype
+|type
 |Query
-|[[Map Type]]
+|[[Net 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:'''
-{|class=wikitable
-!Name
-!Location
-!Type
-!Default value
-|-
-|format
-|Path
-|String
-|
-|-
-|bbox
-|Query
-|String
 |
 |-
@@ Line 864: / Line 940: @@
 |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==
+==Overlay==
-===getLines===
+===getOverlays===
-Path: web/lines.geojson
+Path: web/overlays.geojson
 Type: GET
@@ Line 916: / Line 957: @@
 !Default value
 |-
-|bbox
+|webStakeholderID
-|Query
+|Header
-|String
+|Integer
-|
-|-
-|minlength
-|Query
-|Double
-|
-|-
-|maxlength
-|Query
-|Double
-|
-|-
-|type
-|Query
-|[[Net Type]]
 |
 |-
@@ Line 942: / Line 968: @@
 |}
-==Overlay==
 ===getOverlayImage===
 Path: web/overlay.png
@@ Line 1,026: / Line 1,051: @@
 |}
-===getOverlays===
+==Popup==
-Path: web/overlays.geojson
+===getPopup===
+Path: web/popup.html
 Type: GET
-Produces: application/json
+Produces: text/html
 '''Parameters:'''
@@ Line 1,045: / Line 1,071: @@
 |
 |-
-|crs
+|stakeholderid
+|Query
+|Integer
+|-1
+|-
+|id
+|Query
+|Integer
+|-1
+|-
+|css
 |Query
-|String
+|Boolean
-|EPSG:3857
+|
 |}
-==Popup==
+===getPopupClusters===
-===getPopups===
+Path: web/popupclusters.geojson
-Path: web/popups.geojson
 Type: GET
@@ Line 1,082: / Line 1,117: @@
 |}
-===getPopupClusters===
+===getPopups===
-Path: web/popupclusters.geojson
+Path: web/popups.geojson
 Type: GET
@@ Line 1,110: / Line 1,145: @@
 |String
 |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
-|
 |}

Web Endpoint: Difference between revisions

Revision as of 09:53, 1 June 2026

Web

getKeepAlive

get3DMap

getAssets

getDomainLogo

getLibJS

getPanel

postEventForm

getCSS

get2DMap

ActionMenu

getMeasure

getActionMenuActions

getActionMenus

getCinematic

Indicator

getIndicator

getIndicators

Label

getNeighborhoods

getStreets

Map

getDirection

getFlood

getTerrain

getTerrainTile

getWater

getWMS

postAvgHeight

Net

getLines

Overlay

getOverlays

getOverlayImage

Popup

getPopup

getPopupClusters

getPopups

Scenario

getScenarios

Version

getVersion

getItemVersion

See also

Navigation menu

Search