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


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


Type: GET
Type: GET


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


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


===getCSS===
===getDomainLogo===
Path: web/{name}.css
Path: web/domain.png


Type: GET
Type: GET


Produces: text/css
Produces: image/png
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| name
| Path
| String
|
|-
| replacetoken
| Query
| boolean
| true
|}


'''Parameters:''' None
===getLibJS===
===getLibJS===
Path: web/{name}.js
Path: web/{name}.js
Line 128: Line 106:
|}
|}


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


===getAssets===
===postEventForm===
Path: web/assets/{path : [a-zA-Z0-9/._-]+}
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
Type: GET


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


'''Parameters:'''
'''Parameters:'''
Line 190: Line 188:
!Default value
!Default value
|-
|-
| path
| name
| Path
| Path
| String
| String
|  
|  
|-
| replacetoken
| Query
| boolean
| true
|}
|}


===postEventForm===
===get2DMap===
Path: web/event/{eventclass}/{eventname}
Path: web/{a:2dmap.html|map.html}
 
Type: GET


Type: POST
Produces: text/html


'''Parameters:'''
'''Parameters:'''
Line 213: Line 218:
|  
|  
|-
|-
| eventclass
| base
| Path
| Query
| String
| [[WebBaseMap]]
|
|-
| eventname
| Path
| String
|  
|  
|}
|}
Line 506: Line 506:
|}
|}


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


Type: GET
Type: GET
Line 518: Line 518:
!Default value
!Default value
|-
|-
| webStakeholderID
| format
| Header
| Path
| String
|
|-
| id
| Query
| Integer
| Integer
|  
|  
|-
|-
| request
| overlay
| Query
| Query
| [[Request]]
| Integer
| GetCapabilities
|  
|-
|-
| bbox
| maptype
| Query
| Query
| String
| [[Map Type]]
|  
| MAQUETTE
|-
|-
| width
| width
Line 543: Line 548:
| 256
| 256
|-
|-
| layers
| offset
| Query
| float
| 0
|-
| timeframe
| Query
| int
| 0
|-
| worlddatum
| Query
| boolean
| false
|-
| decimation
| Query
| Query
| int
| 16
|}
===getTerrain===
Path: web/terrain.{format}
Type: GET
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| format
| Path
| String
| String
|  
|  
|-
|-
| layer
| bbox
| Query
| Query
| String
| String
|  
|  
|-
| timeframe
| Query
| int
| 0
|-
|-
| crs
| crs
Line 563: Line 596:
| EPSG:3857
| EPSG:3857
|-
|-
| forcexy
| id
| Query
| Query
| Boolean
| Integer
|  
|  
|-
|-
Line 573: Line 606:
| 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
|}
|}


===postAvgHeight===
===getTerrainTile===
Path: web/avgheight.number
Path: web/terrain/{z}/{x}/{y}.{format}
 
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 666: Line 649:
|  
|  
|-
|-
| id
| z
| Query
| Path
| Integer
| int
|
|-
| x
| Path
| int
|  
|  
|-
|-
| overlay
| y
| Query
| Path
| Integer
| int
|  
|  
|-
|-
| maptype
| v
| Query
| Query
| [[Map Type]]
| String
| MAQUETTE
|  
|-
|-
| width
| width
Line 696: Line 684:
| 0
| 0
|-
|-
| timeframe
| maptype
| Query
| Query
| int
| [[Map Type]]
| 0
| MAQUETTE
|-
|-
| worlddatum
| worlddatum
Line 770: Line 758:
|}
|}


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


Type: GET
Type: GET
Line 782: Line 770:
!Default value
!Default value
|-
|-
| format
| webStakeholderID
| Path
| Header
| String
| Integer
|  
|  
|-
|-
| bbox
| request
| Query
| Query
| String
| [[Request]]
|  
| GetCapabilities
|-
|-
| crs
| bbox
| Query
| Query
| String
| String
| EPSG:3857
|-
| id
| Query
| Integer
|  
|  
|-
| maptype
| Query
| [[Map Type]]
| MAQUETTE
|-
|-
| width
| width
Line 817: Line 795:
| 256
| 256
|-
|-
| offset
| layers
| Query
| Query
| float
| String
| 0
|  
|-
|-
| worlddatum
| layer
| Query
| Query
| boolean
| String
| false
|  
|-
|-
| decimation
| timeframe
| Query
| Query
| int
| int
| 16
| 0
|}
 
===getTerrainTile===
Path: web/terrain/{z}/{x}/{y}.{format}
 
Type: GET
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|-
| format
| crs
| Path
| Query
| String
| String
| EPSG:3857
|-
| forcexy
| Query
| Boolean
|  
|  
|-
|-
| z
| maptype
| Path
| Query
| int
| [[Map Type]]
|  
| MAQUETTE
|-
|-
| x
| x
| Path
| Query
| int
| int
|  
| -1
|-
|-
| y
| y
| Path
| Query
| int
| -1
|-
| i
| Query
| int
| -1
|-
| j
| Query
| int
| int
| -1
|-
| bgcolor
| Query
| String
|  
|  
|-
|-
| v
| format
| Query
| Query
| String
| String
|  
|  
|-
|-
| width
| info_format
| Query
| String
| text/plain
|-
| walled
| Query
| Query
| int
| boolean
| 256
| true
|-
|-
| height
| styles
| Query
| Query
| int
| String
| 256
|  
|}
 
===postAvgHeight===
Path: web/avgheight.number
 
Type: POST
 
Produces: application/json , application/octet-stream
 
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
|-
| offset
| f
| Query
| Query
| float
| [[Format]]
| 0
| JSON
|-
|-
| maptype
| maptype
Line 890: Line 895:
| MAQUETTE
| MAQUETTE
|-
|-
| worlddatum
| buildings
| Query
| Query
| boolean
| boolean
| false
| false
|-
| decimation
| Query
| int
| 16
|}
|}


Line 943: Line 943:


==Overlay==
==Overlay==
===getOverlays===
Path: web/overlays.geojson
Type: GET
Produces: application/json
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| crs
| Query
| String
| EPSG:3857
|}
===getOverlayImage===
===getOverlayImage===
Path: web/overlay.png
Path: web/overlay.png
Line 1,024: Line 1,049:
| String
| String
|  
|  
|}
===getOverlays===
Path: web/overlays.geojson
Type: GET
Produces: application/json
'''Parameters:'''
{|class=wikitable
!Name
!Location
!Type
!Default value
|-
| webStakeholderID
| Header
| Integer
|
|-
| crs
| Query
| String
| EPSG:3857
|}
|}


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


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


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


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


Type: GET
Type: GET

Revision as of 12:47, 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

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

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

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

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

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Web_Endpoint&oldid=85310"