GET-Parameter

From MapbenderWiki
Jump to: navigation, search

Version

version 0.1, 2010-07-22
version 0.2, 2010-08-05
version 0.2.1, 2010-08-06
version 0.2.2, 2010-08-10
version 0.2.3, 2010-09-20
version 0.2.4, 2010-09-21 (WMS is working now)
version 0.2.5, 2010-09-22 (LAYER is working now)

We will start to use and enhance this convention starting with Mapbender 2.7. We are aiming for a complete implementation with Mapbender 3.0, which will also result in a 1.0 version of this document. All older GET parameters will no longer be supported in Mapbender 3.0. In Mapbender 2.7 however, they should remain functional.

Conventions

  • GET parameters must be all capitals (BBOX), where necessary, use an underscore (WFS_CONF_ID)
  • every unknown URL-Parameter (including keywords in wrong case like ZoOm) is logged as a notice (e.g. 'Unknown Parameter 'ZoOm' , 'Unknow Parameter UDGBoef') to aid in

debugging

Parameters

These parameters are ordered by priority. The parameters lower in the list are of higher priority.

to do

ready for testing

done

WMC

Load a WMC document from the Mapbender database

Examples

Load a WMC (discards the current services)

&WMC=123
http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMC=1

Merge a WMC (updates existing services and adds new services)

&WMC[0][id]=123&WMC[0][merge]=1

Merge multiple WMC (inheritance)

&WMC[0][id]=123&WMC[1][id]=124&WMC[1][merge]=1&WMC[2][id]=125&WMC[2][merge]=1

FEATURETYPE

Examples

Load a configured featuretype (also known as WFS_CONF)

FEATURETYPE=12

Load multiple configured featuretypes

FEATURETYPE=12,13
FEATURETYPE[]=12&FEATURETYPE[]=13

Customize configured featuretype, like a default search

FEATURETYPE[active]=1&FEATURETYPE[search][firstname]=a&FEATURETYPE[search][lastname]=b&FEATURETYPE[id]=12

WMS

Examples

Load from GetCapabilities document by ID or URL

WMS=12

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=584
WMS=http:/⁄example.com

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=http://www.bsc-eoc.org/cgi-bin/bsc_ows.asp?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS
http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=http%3A%2F%2Fgeoportal.landau.de%2Fcgi-bin%2Fmapserv%3Fmap%3D%2Fhome%2Fknoppix%2Fwebgis-cd%2Fmapserver%2Fmapfiles%2Fbebauungsplaene_gdikommune.map%26%26REQUEST%3DGetCapabilities%26VERSION%3D1.1.1%26SERVICE%3DWMS
cascaded layers: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=http%3A%2F%2Fwww.geobasisdaten.niedersachsen.de%2Frds%3F%26REQUEST%3DGetCapabilities%26VERSION%3D1.1.1%26SERVICE%3DWMS
cascaded layers: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=http%3A%2F%2Fprod.landentwicklung-online.thueringen.de%2Fcgi-bin%2Fmapserv%3Fmap%3D%2Fhome%2Flewonl%2Fdata%2Fumn%2Fverfahren_sgj.map%26SERVICE%3DWMS%26REQUEST%3DGetCapabilities%26version%3D1.1.1


Load multiple WMS

WMS=12,13

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=584,800
WMS[]=12&WMS[]=13

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[]=584&WMS[]=800
WMS=http:⁄/example.com,http:/⁄example.net

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS=http://www.bsc-eoc.org/cgi-bin/bsc_ows.asp?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS,http://geoint.lmic.state.mn.us/cgi-bin/wms?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS 
WMS[]=http:/⁄example.com&WMS[]=http:/⁄example.net

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[]=http://www.bsc-eoc.org/cgi-bin/bsc_ows.asp?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS&WMS[]=http://geoint.lmic.state.mn.us/cgi-bin/wms?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS 


Load the WMS as configured in the specified application (if the application parameter is not used, the WMS default getCapabilites Document is used)

WMS[application]=gui1&WMS[id]=12

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[application]=wms_north_america&WMS[id]=584

Override default settings with custom settings (works with all above)

Visibility

WMS[visible]=1&WMS[application]=gui1&WMS[id]=12

visible: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[visible]=1&WMS[application]=wms_north_america&WMS[id]=584
hidden: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[visible]=0&WMS[application]=wms_north_america&WMS[id]=584

Zoom to extent

WMS[0][visible]=1&WMS[0][zoom]=1&WMS[0][url]=http:/⁄example.org

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[0][visible]=1&WMS[0][zoom]=1&WMS[0][url]=http%3A%2F%2Fprod.landentwicklung-online.thueringen.de%2Fcgi-bin%2Fmapserv%3Fmap%3D%2Fhome%2Flewonl%2Fdata%2Fumn%2Fverfahren_sgj.map%26SERVICE%3DWMS%26REQUEST%3DGetCapabilities%26version%3D1.1.1

Override multiple

WMS[0][visible]=1&WMS[0][url]=http:/⁄example.org&WMS[1][visible]=0&WMS[1][url]=http:/⁄example.net

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&WMS[0][visible]=0&WMS[0][url]=http://www.bsc-eoc.org/cgi-bin/bsc_ows.asp?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS&WMS[1][visible]=1&WMS[1][url]=http://geoint.lmic.state.mn.us/cgi-bin/wms?VERSION=1.1.1%26REQUEST=GetCapabilities%26SERVICE=WMS

LAYER

Examples

Load the layer by ID, but unconfigured

LAYER=12
http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[0][id]=20129&LAYER[0][zoom]=1&LAYER[0][visible]=1&LAYER[0][application]=wms_germany
http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER=2723
Root layer: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER=19176
Layer with both parents and children: http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[]=14266
LAYER=12,13

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER=2723,10989
LAYER[]=12&LAYER[]=13

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[]=2723&LAYER[]=10989

Load the layer (WMS with cascaded layers) as configured in the specified application

LAYER[application]=gui1&LAYER[id]=12

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[0][application]=wms_germany&LAYER[0][id]=3407

Load multiple layers (one is configured, one isn't)

LAYER[0][application]=gui1&LAYER[0][id]=12&LAYER[1]=13

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[0][application]=wms_germany&LAYER[0][id]=3407&LAYER[1][id]=10989

Override default settings with custom settings (in this case: make layer visible and zoom to its extent. Works with all above)

LAYER[visible]=1&LAYER[zoom]=1&LAYER[application]=gui1&LAYER[id]=12

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[visible]=1&LAYER[zoom]=1&LAYER[application]=wms_germany&LAYER[id]=3407
LAYER[querylayer]=1&LAYER[application]=gui&LAYER[id]=15339

http://localhost/trunk/frames/login.php?name=root&password=root&mb_user_myGui=gui1&LAYER[querylayer]=1&LAYER[application]=gui&LAYER[id]=15339

CRS

A coordinate reference system, EPSG:XYZ. The current Mapbender application will do a reprojection into the given crs.

Example:

&CRS=EPSG:31467

GEORSS

An URL or an array of URLs to GeoRSS feeds

Examples

Load a single feed

&GEORSS=http:/⁄example.com

Load multiple feeds

&GEORSS[]=http:/⁄example.com&GEORSS[]=http:/⁄example.net

GEOJSON Parameters (since 09/2016)

GEOJSON

An URL or an array of URLs or a urlencoded object itself to geojson featurecollections (supports simple style spec)

Examples

Load a single collection

 &GEOJSON[]=http%3A%2F%2Fwww.geoportal.rlp.de%2Fmetadata%2Ftestpolygon.json

Load a multiple collections

 &GEOJSON[]=http%3A%2F%2Fwww.geoportal.rlp.de%2Fmetadata%2Ftestpolygon.json

Load a collection which is given as object in the URL

 &GEOJSON[]=%7B%0A%09%22uuid%22%3A%20%2253d46f7b-0b49-4076-b113-08eca33efc3c%22%2C%0A%09%22created%22%3A%20%222016-09-28T08%3A31%3A02.477Z%22%2C%0A%09%22title%22%3A%20%22test%22%2C%0A%09%22updated%22%3A%20%222016-09-28T08%3A31%3A30.192Z%22%2C%0A%09%22version%22%3A%20%22v1%22%2C%0A%09%22type%22%3A%20%22FeatureCollection%22%2C%0A%09%22features%22%3A%20%5B%7B%0A%09%09%22type%22%3A%20%22Feature%22%2C%0A%09%09%22geometry%22%3A%20%7B%0A%09%09%09%22type%22%3A%20%22Polygon%22%2C%0A%09%09%09%22coordinates%22%3A%20%5B%0A%09%09%09%09%5B%0A%09%09%09%09%09%5B6.67%2C%2050.21%5D%2C%0A%09%09%09%09%09%5B6.88%2C%2050.31%5D%2C%0A%09%09%09%09%09%5B7.26%2C%2050.07%5D%2C%0A%09%09%09%09%09%5B6.77%2C%2049.8%5D%2C%0A%09%09%09%09%09%5B6.49%2C%2049.9%5D%2C%0A%09%09%09%09%09%5B6.39%2C%2050.24%5D%2C%0A%09%09%09%09%09%5B6.67%2C%2050.21%5D%0A%09%09%09%09%5D%0A%09%09%09%5D%0A%09%09%7D%2C%0A%09%09%22properties%22%3A%20%7B%0A%09%09%09%22title%22%3A%20%22title%22%2C%0A%09%09%09%22name%22%3A%20%22wald%22%2C%0A%09%09%09%22description%22%3A%20%22Beschreibung%20CDATA%22%2C%0A%09%09%09%22area%22%3A%20%222044049394.2601%22%2C%0A%09%09%09%22boundary-length%22%3A%20%22184726.618%22%2C%0A%09%09%09%22stroke%22%3A%20%22%23555555%22%2C%0A%09%09%09%22stroke-opacity%22%3A%20%221%22%2C%0A%09%09%09%22stroke-width%22%3A%20%222%22%2C%0A%09%09%09%22fill%22%3A%20%22%23555555%22%2C%0A%09%09%09%22fill-opacity%22%3A%20%220.5%22%2C%0A%09%09%09%22nutzung%22%3A%20%22baum%22%2C%0A%09%09%09%22updated%22%3A%20%222016-09-28T08%3A31%3A30.191Z%22%0A%09%09%7D%0A%09%7D%5D%0A%7D

GEOJSONZOOM

Possibility to zoom to the extent of the geojson which is given via GEOJSON parameter. If only one point is given or there is no real extent then an fictive offset of 100m is assumed!

Examples
 &GEOJSON[]=http%3A%2F%2Fwww.geoportal.rlp.de%2Fmetadata%2Ftestpolygon.json&GEOJSONZOOM=true

GEOJSONZOOMOFFSET

Possibility to give a OFFSET in [m] which defines a frame for the extent given in via GEOJSONZOOM parameter

Examples
 &GEOJSON[]=http%3A%2F%2Fwww.geoportal.rlp.de%2Fmetadata%2Ftestpolygon.json&GEOJSONZOOM=true&GEOJSONOFFSET=100000

KML

An URL or an array of URLs to KML documents

Example

Load a single document

&KML=http:/⁄example.com

Load multiple documents

&KML[]=http:/⁄example.com&KML[]=http:/⁄example.net

ZOOM

zoom to extent

A comma separated list of coordinates, sw.x,sw.y,ne.x,ne.y. The current Mapbender application will zoom to this extent.

Example
&ZOOM=3617000,5411000,3787000,5700000

A comma separated list of coordinates and the coordinate reference system of the given coordinates, sw.x,sw.y,ne.x,ne.y,EPSG:XYZ. The current Mapbender application will transform the given coordinates into the current application crs according to the given crs and zoom to this extent.

Example
&ZOOM=3617000,5411000,3787000,5700000,EPSG%3A1467
zoom to point with scale
Example

A comma separated list of coordinates and a scale, p.x,p.y,scale. The current Mapbender application will zoom to this point at the given scale

&ZOOM=3617000,5411000,100000
Example

A comma separated list of coordinates, a scale, and a CRS p.x,p.y,scale,crs. The current Mapbender application will transform this point into the current application CRS and then zoom to the transformed point at the given scale

&ZOOM=3617000,5411000,100000,EPSG%3A31467
zoom to geographic entity

See LAYER, WMS, KML, GEORSS, WMC