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
39,237 edits
No edit summary
No edit summary
Line 2: Line 2:


==Web==
==Web==
===get3DMap===
===getKeepAlive===
Path: web/{a:3dmap.html|cesium.html}
Path: web/resettimeout
 
Type: GET
 
Produces: text/plain
 
'''Parameters:''' None
===getPanel===
Path: web/{path:|index.html|panel.html|panel.body}


Type: GET
Type: GET
Line 21: Line 29:
|
|
|-
|-
|overlay
|stakeholderid
|Query
|Query
|Integer
|Integer
|
|-1
|-
|-
|base
|path
|Query
|Path
|[[WebBaseMap]]
|String
|
|
|-
|-
|style
|id
|Query
|Query
|[[WebModelStyle]]
|Integer
|
|-1
|-
|-
|shadow
|css
|Query
|Query
|Boolean
|Boolean
|
|-
|texture
|Query
|[[TextureSize]]
|
|-
|spacing
|Query
|Double
|
|
|}
|}


===getAssets===
===postEventForm===
Path: web/assets/{path : [a-zA-Z0-9/._-]+}
Path: web/event/{eventclass}/{eventname}


Type: GET
Type: POST
 
Produces: image/png , image/jpeg


'''Parameters:'''
'''Parameters:'''
Line 66: Line 62:
!Default value
!Default value
|-
|-
|path
|webStakeholderID
|Header
|Integer
|
|-
|eventclass
|Path
|String
|
|-
|eventname
|Path
|Path
|String
|String
Line 72: Line 78:
|}
|}


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


Type: GET
Type: GET


Produces: image/png
Produces: text/css
 
'''Parameters:''' None
===getLibJS===
Path: web/{name}.js
 
Type: GET


'''Parameters:'''
'''Parameters:'''
Line 96: Line 96:
|String
|String
|
|
|-
|replacetoken
|Query
|boolean
|true
|}
|}


===getPanel===
===get2DMap===
Path: web/{path:|index.html|panel.html|panel.body}
Path: web/{a:2dmap.html|map.html}


Type: GET
Type: GET
Line 117: Line 122:
|
|
|-
|-
|stakeholderid
|base
|Query
|Query
|Integer
|[[WebBaseMap]]
|-1
|-
|path
|Path
|String
|
|-
|id
|Query
|Integer
|-1
|-
|css
|Query
|Boolean
|
|
|}
|}


===postEventForm===
===get3DMap===
Path: web/event/{eventclass}/{eventname}
Path: web/{a:3dmap.html|cesium.html}
 
Type: GET


Type: POST
Produces: text/html


'''Parameters:'''
'''Parameters:'''
Line 155: Line 147:
|
|
|-
|-
|eventclass
|overlay
|Path
|Query
|String
|Integer
|
|-
|base
|Query
|[[WebBaseMap]]
|
|-
|style
|Query
|[[WebModelStyle]]
|
|-
|shadow
|Query
|Boolean
|
|-
|texture
|Query
|[[TextureSize]]
|
|
|-
|-
|eventname
|spacing
|Path
|Query
|String
|Double
|
|
|}
|}


===getKeepAlive===
===getAssets===
Path: web/resettimeout
Path: web/assets/{path : [a-zA-Z0-9/._-]+}


Type: GET
Type: GET


Produces: text/plain
Produces: image/png , image/jpeg
 
'''Parameters:''' None
===getCSS===
Path: web/{name}.css
 
Type: GET
 
Produces: text/css


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


===get2DMap===
===getDomainLogo===
Path: web/{a:2dmap.html|map.html}
Path: web/domain.png


Type: GET
Type: GET


Produces: text/html
Produces: image/png
 
'''Parameters:''' None
===getLibJS===
Path: web/{name}.js
 
Type: GET


'''Parameters:'''
'''Parameters:'''
Line 213: Line 218:
!Default value
!Default value
|-
|-
|webStakeholderID
|name
|Header
|Path
|Integer
|String
|
|-
|base
|Query
|[[WebBaseMap]]
|
|
|}
|}
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 504: Line 504:
|boolean
|boolean
|0
|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
|Query
|[[Map Type]]
|MAQUETTE
|-
|buildings
|Query
|boolean
|false
|}
|}


Line 869: Line 899:
|String
|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
|}
|}


Revision as of 08:57, 3 June 2026

General path: web/

Web

getKeepAlive

Path: web/resettimeout

Type: GET

Produces: text/plain

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

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

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

ActionMenu

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

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

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

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

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

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

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

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

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=83315"