Skip to content

APIs

Jump to bottom
Armin Retterath edited this page Feb 19, 2025 · 13 revisions

HTTP based access to mapbenders resources and services

Mapbender client API

https://documents.geoportal.rlp.de/mediawiki/index.php/GET-Parameter

Additional Parameters

  • name: NONEDEFAULTWMC

Initialization of Mapbender GUI

flowchart TD
    A["javascripts/initWmcObj.php"] -->|"get GUI & WMC from session"| C{"if \n elementVar \n loadFromSession \n == 1"}
    C --> D["Load from session WMC \n wmc->createFromXml"]
    C --> E["Load from application \n wmc->createFromApplication"]
    D --> F["Mapbender WMC Object"]
    E --> F
    F --> G["Evaluate GET Parameter: \n WMC \n LAYER \n ZOOM \n GEOJSON \n ..."]
    G --> H["Merge WMS / Layer / WMC"]
    H --> I["Handle Constraints: \n Permissions \n Conditions \n Availability"]
    I --> J["Export javascript Object \n wmc->wmsToJavaScript()"]
Loading

Mobilemap API

https://documents.geoportal.rlp.de/mediawiki/index.php/Mobilemap2

OL2 client API

https://documents.geoportal.rlp.de//mediawiki/index.php/Mod_wmc2ol.php

SearchInterface

https://documents.geoportal.rlp.de//mediawiki/index.php/SearchInterface

Remote CSW Search (works like SeachInterface before)

Endpoint

https://www.geoportal.rlp.de/mapbender/php/mod_callCswMetadata.php?catalogueId=6&searchResources=dataset

Catalogues

https://www.geoportal.rlp.de/mapbender/php/mod_showCswList.php

Resolve data service coupling

https://www.geoportal.rlp.de/mapbender/php/mod_getCoupledResourcesForDataset.php?getRecordByIdUrl=https%3A%2F%2Fvocabulary.geoportal.rlp.de%2Fgeonetwork%2Fsrv%2Feng%2Fcsw%3Frequest%3DGetRecordById%26service%3DCSW%26version%3D2.0.2%26Id%3D4ff6f9fc-d57a-6f6a-bcc2-c1cbaef4e414%26ElementSetName%3Dfull%26OUTPUTSCHEMA%3Dhttp%3A%2F%2Fwww.isotc211.org%2F2005%2Fgmd

Metadata resolver / transformator

https://www.geoportal.rlp.de/mapbender/php/mod_exportIso19139.php?languageCode=en&url=https%3A%2F%2Fwww.geoportal.rlp.de%2Fmapbender%2Fphp%2Fmod_dataISOMetadata.php%3FoutputFormat%3Diso19139%26id%3D2b009ae4-aa3e-ff21-870b-49846d9561b2 https://www.geoportal.rlp.de/mapbender/php/mod_exportIso19139.php?languageCode=en&url=https%3A%2F%2Fvocabulary.geoportal.rlp.de%2Fgeonetwork%2Fsrv%2Feng%2Fcsw%3Frequest%3DGetRecordById%26service%3DCSW%26version%3D2.0.2%26Id%3D4ff6f9fc-d57a-6f6a-bcc2-c1cbaef4e414%26ElementSetName%3Dfull%26OUTPUTSCHEMA%3Dhttp%3A%2F%2Fwww.isotc211.org%2F2005%2Fgmd&resolveCoupledResources=true

Update WMS and WFS as root or from php-cli

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/mod_updateOwsRoot.php

parameters

  • name: serviceType
  • name: serviceId

Further description

The webservice is used to update many services via batch like this is done by the update scheduler, which normally run as a simple cronjob. It can only be invoked from the server itself, or by the authenticated root user of the instance. If the update is invoked, the configuration of an existing scheduler is used. The scheduler defines how the service should be updated. The configuration of the scheduler may be overwritten, if this is wished! Simply add scheduler_conf Parameters with the values "true" or "false". Example: https://www.geoportal.rlp.de/mapbender/php/mod_updateOwsRoot.php?serviceId=15&serviceType=wfs&schedulerOverwrite=true

Result

The result is given back as a simple json object with further information about the update process:

{"success":true,"result":{"service_title":"INSPIRE-WFS SL Verwaltungseinheiten ALKIS","service_id":"15","overwrite":true,"number_of_resources":3,"service_type":"WFS","duration_time":6.481965065002441,"scheduler_conf":{"schedulerPublish":null,"schedulerSearchable":null,"schedulerOverwrite":null,"schedulerOverwriteCategories":null}},"message":"Service with id 15 updated!"}

Information about organizations

List of all organizations

Used to generate Organization view. It also shows how many resources are published.

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/mod_showOrganizationList.php

parameters

  • name: orderBy

Single organization

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/mod_showOrganizationInfo.php

parameters

  • name: id
  • name: uuid
  • name: outputFormat

List of all organizations which publish resources with opendata compatible licenses

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/mod_showOpenDataOrganizations.php

parameters

  • name: showOnlyDatasetMetadata
  • name: showOnlyUnlinkedOrganizations

CKAN sync tools

Synchronize organizations & resources

Used to sync organizations and resources from mapbender to connected ckan-instance. Is also invoked from webinterface (Admin Metadata). The synchronization maybe started by the owner of the metadata or by mapbenders root user. Syncing organizations is only possible logged in as root. Normally only the synchronization of organizations is invoked by simple http-requests. Therefor only this parameter is described bellow. If the organization does not exists in the ckan-instance, it will be created. Also an editor account will be created. The metadata, which will be exchanged later, will be owned by this editor account ("spatial data editor").

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/mod_syncCkan_server.php

parameters

  • name: operation

Path

https://github.com/mrmap-community/Mapbender2.8/blob/master/http/php/syncCkanRoot.php

parameters

  • name: syncDepartment

Export DCAT

DCAT 3.0 for orga

https://www.geoportal.rlp.de/mapbender/php/mod_exportMapbenderMetadata2Ckan.php?cache=false&id=31&outputFormat=rdfxml&restrictToOpenData=false

GeoDCAT via Metadata export (xslt from INSPIRE)

https://www.geoportal.rlp.de/mapbender/php/mod_exportIso19139.php?outputFormat=rdf&languageCode=en&url=https%3A%2F%2Fwww.geoportal.rlp.de%2Fmapbender%2Fphp%2Fmod_dataISOMetadata.php%3FoutputFormat%3Diso19139%26id%3D2b009ae4-aa3e-ff21-870b-49846d9561b2

Clone this wiki locally