Web Endpoint: Difference between revisions
No edit summary Tag: Manual revert |
No edit summary |
||
| Line 106: | Line 106: | ||
|} | |} | ||
=== | ===getCSS=== | ||
Path: web/{ | Path: web/{name}.css | ||
Type: GET | Type: GET | ||
Produces: text/ | Produces: text/css | ||
'''Parameters:''' | '''Parameters:''' | ||
| Line 120: | Line 120: | ||
!Default value | !Default value | ||
|- | |- | ||
| | | name | ||
| Path | | Path | ||
| String | | String | ||
| | | | ||
|- | |- | ||
| | | replacetoken | ||
| Query | | Query | ||
| | | boolean | ||
| true | |||
| | |||
|} | |} | ||
=== | ===get2DMap=== | ||
Path: web | Path: web/{a:2dmap.html|map.html} | ||
Type: GET | |||
Produces: text/html | |||
'''Parameters:''' | '''Parameters:''' | ||
| Line 163: | Line 150: | ||
| | | | ||
|- | |- | ||
| | | base | ||
| | | Query | ||
| | | [[WebBaseMap]] | ||
| | | | ||
|} | |} | ||
=== | ===getPanel=== | ||
Path: web/{ | Path: web/{path:|index.html|panel.html|panel.body} | ||
Type: GET | Type: GET | ||
Produces: text/ | Produces: text/html | ||
'''Parameters:''' | '''Parameters:''' | ||
| Line 188: | Line 170: | ||
!Default value | !Default value | ||
|- | |- | ||
| | | webStakeholderID | ||
| Header | |||
| Integer | |||
| | |||
|- | |||
| stakeholderid | |||
| Query | |||
| Integer | |||
| -1 | |||
|- | |||
| path | |||
| Path | | Path | ||
| String | | String | ||
| | | | ||
|- | |- | ||
| | | id | ||
| Query | |||
| Integer | |||
| -1 | |||
|- | |||
| css | |||
| Query | | Query | ||
| | | Boolean | ||
| | | | ||
|} | |} | ||
=== | ===postEventForm=== | ||
Path: web/{ | Path: web/event/{eventclass}/{eventname} | ||
Type: | Type: POST | ||
'''Parameters:''' | '''Parameters:''' | ||
| Line 218: | Line 213: | ||
| | | | ||
|- | |- | ||
| | | eventclass | ||
| | | Path | ||
| | | String | ||
| | |||
|- | |||
| eventname | |||
| Path | |||
| String | |||
| | | | ||
|} | |} | ||
| Line 504: | Line 504: | ||
| boolean | | boolean | ||
| 0 | | 0 | ||
|} | |||
===getWMS=== | |||
Path: web/wms | |||
Type: GET | |||
'''Parameters:''' | |||
{|class=wikitable | |||
!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:''' | |||
{|class=wikitable | |||
!Name | |||
!Location | |||
!Type | |||
!Default value | |||
|- | |||
| f | |||
| Query | |||
| [[Format]] | |||
| JSON | |||
|- | |||
| maptype | |||
| Query | |||
| [[Map Type]] | |||
| MAQUETTE | |||
|- | |||
| buildings | |||
| Query | |||
| boolean | |||
| false | |||
|} | |} | ||
| Line 756: | Line 899: | ||
| int | | int | ||
| 16 | | 16 | ||
|} | |} | ||
Revision as of 13:51, 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 |
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 |
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 |
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 |
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 |
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 |
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 |
Popup
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 |
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 |