Web Endpoint: Difference between revisions
Created page with "General path: web/ =Web= ==getKeepAlive== Path: web/resettimeout Type: GET Produces: text/plain '''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..." |
No edit summary |
||
| Line 1: | Line 1: | ||
General path: web/ | General path: web/ | ||
=Web= | ==Web== | ||
==getKeepAlive== | ===getKeepAlive=== | ||
Path: web/resettimeout | Path: web/resettimeout | ||
| Line 10: | Line 10: | ||
'''Parameters:''' None | '''Parameters:''' None | ||
==getCSS== | ===getCSS=== | ||
Path: web/{name}.css | Path: web/{name}.css | ||
| Line 35: | Line 35: | ||
|} | |} | ||
==get2DMap== | ===get2DMap=== | ||
Path: web/{a:2dmap.html|map.html} | Path: web/{a:2dmap.html|map.html} | ||
| Line 60: | Line 60: | ||
|} | |} | ||
==get3DMap== | ===get3DMap=== | ||
Path: web/{a:3dmap.html|cesium.html} | Path: web/{a:3dmap.html|cesium.html} | ||
| Line 110: | Line 110: | ||
|} | |} | ||
==getAssets== | ===getAssets=== | ||
Path: web/assets/{path : [a-zA-Z0-9/._-]+} | Path: web/assets/{path : [a-zA-Z0-9/._-]+} | ||
| Line 130: | Line 130: | ||
|} | |} | ||
==getDomainLogo== | ===getDomainLogo=== | ||
Path: web/domain.png | Path: web/domain.png | ||
| Line 138: | Line 138: | ||
'''Parameters:''' None | '''Parameters:''' None | ||
==getLibJS== | ===getLibJS=== | ||
Path: web/{name}.js | Path: web/{name}.js | ||
| Line 156: | Line 156: | ||
|} | |} | ||
==getPanel== | ===getPanel=== | ||
Path: web/{path:|index.html|panel.html|panel.body} | Path: web/{path:|index.html|panel.html|panel.body} | ||
| Line 196: | Line 196: | ||
|} | |} | ||
==postEventForm== | ===postEventForm=== | ||
Path: web/event/{eventclass}/{eventname} | Path: web/event/{eventclass}/{eventname} | ||
| Line 224: | Line 224: | ||
|} | |} | ||
=ActionMenu= | ==ActionMenu== | ||
==getMeasure== | ===getMeasure=== | ||
Path: web/measure.geojson | Path: web/measure.geojson | ||
| Line 260: | Line 260: | ||
|} | |} | ||
==getActionMenuActions== | ===getActionMenuActions=== | ||
Path: web/actionmenuactions.geojson | Path: web/actionmenuactions.geojson | ||
| Line 290: | Line 290: | ||
|} | |} | ||
==getActionMenus== | ===getActionMenus=== | ||
Path: web/actionmenus.geojson | Path: web/actionmenus.geojson | ||
| Line 315: | Line 315: | ||
|} | |} | ||
==getCinematic== | ===getCinematic=== | ||
Path: web/cinematic.geojson | Path: web/cinematic.geojson | ||
| Line 350: | Line 350: | ||
|} | |} | ||
=Indicator= | ==Indicator== | ||
==getIndicator== | ===getIndicator=== | ||
Path: web/indicator.html | Path: web/indicator.html | ||
| Line 386: | Line 386: | ||
|} | |} | ||
==getIndicators== | ===getIndicators=== | ||
Path: web/indicators.geojson | Path: web/indicators.geojson | ||
| Line 411: | Line 411: | ||
|} | |} | ||
=Label= | ==Label== | ||
==getNeighborhoods== | ===getNeighborhoods=== | ||
Path: web/neighborhoods.geojson | Path: web/neighborhoods.geojson | ||
| Line 432: | Line 432: | ||
|} | |} | ||
==getStreets== | ===getStreets=== | ||
Path: web/streets.geojson | Path: web/streets.geojson | ||
| Line 452: | Line 452: | ||
|} | |} | ||
=Map= | ==Map== | ||
==getDirection== | ===getDirection=== | ||
Path: web/direction.{format} | Path: web/direction.{format} | ||
| Line 506: | Line 506: | ||
|} | |} | ||
==getFlood== | ===getFlood=== | ||
Path: web/flood.{format} | Path: web/flood.{format} | ||
| Line 569: | Line 569: | ||
|} | |} | ||
==getTerrain== | ===getTerrain=== | ||
Path: web/terrain.{format} | Path: web/terrain.{format} | ||
| Line 632: | Line 632: | ||
|} | |} | ||
==getTerrainTile== | ===getTerrainTile=== | ||
Path: web/terrain/{z}/{x}/{y}.{format} | Path: web/terrain/{z}/{x}/{y}.{format} | ||
| Line 700: | Line 700: | ||
|} | |} | ||
==getWater== | ===getWater=== | ||
Path: web/water.{format} | Path: web/water.{format} | ||
| Line 758: | Line 758: | ||
|} | |} | ||
==getWMS== | ===getWMS=== | ||
Path: web/wms | Path: web/wms | ||
| Line 871: | Line 871: | ||
|} | |} | ||
==postAvgHeight== | ===postAvgHeight=== | ||
Path: web/avgheight.number | Path: web/avgheight.number | ||
| Line 901: | Line 901: | ||
|} | |} | ||
=Net= | ==Net== | ||
==getLines== | ===getLines=== | ||
Path: web/lines.geojson | Path: web/lines.geojson | ||
| Line 942: | Line 942: | ||
|} | |} | ||
=Overlay= | ==Overlay== | ||
==getOverlays== | ===getOverlays=== | ||
Path: web/overlays.geojson | Path: web/overlays.geojson | ||
| Line 968: | Line 968: | ||
|} | |} | ||
==getOverlayImage== | ===getOverlayImage=== | ||
Path: web/overlay.png | Path: web/overlay.png | ||
| Line 1,051: | Line 1,051: | ||
|} | |} | ||
=Popup= | ==Popup== | ||
==getPopup== | ===getPopup=== | ||
Path: web/popup.html | Path: web/popup.html | ||
| Line 1,087: | Line 1,087: | ||
|} | |} | ||
==getPopupClusters== | ===getPopupClusters=== | ||
Path: web/popupclusters.geojson | Path: web/popupclusters.geojson | ||
| Line 1,117: | Line 1,117: | ||
|} | |} | ||
==getPopups== | ===getPopups=== | ||
Path: web/popups.geojson | Path: web/popups.geojson | ||
| Line 1,147: | Line 1,147: | ||
|} | |} | ||
=Scenario= | ==Scenario== | ||
==getScenarios== | ===getScenarios=== | ||
Path: web/scenarios.geojson | Path: web/scenarios.geojson | ||
| Line 1,173: | Line 1,173: | ||
|} | |} | ||
=Version= | ==Version== | ||
==getVersion== | ===getVersion=== | ||
Path: web/version.json | Path: web/version.json | ||
| Line 1,194: | Line 1,194: | ||
|} | |} | ||
==getItemVersion== | ===getItemVersion=== | ||
Path: web/itemversion.json | Path: web/itemversion.json | ||
Revision as of 12:10, 6 May 2026
General path: web/
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 |
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 | 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 |
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 | MapType | 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 | MapType | 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 | MapType | 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 | MapType | 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 | MapType | 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 | MapType | 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 | MapType | 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 | MapType | 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 | NetType | |
| 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 | MapType | 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 |
Popup
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 |
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 |