Attentation: this API will be depreciated with v4.0 (we are working on an alternative)

RESTful API documentation

back to API overview

RESTful API endpoints

  1. Introduction
  2. Authentication
  3. Testing the API
  4. Response Format
  5. Endpoints
    1. Markers
      1. get_marker
      2. add_marker
      3. add_markers
      4. update_marker
      5. update_markers
      6. delete_marker
      7. delete_markers
      8. search_markers
      9. count_markers
    2. Layers
      1. get_layer
      2. add_layer
      3. add_layers
      4. delete_layer
      5. delete_layers
      6. update_layer
      7. update_layers
      8. search_layers
      9. count_layers
  6. Permissions
    1. current_user_can_any
  7. Parameters
    1. Available parameters for type marker
    2. Available parameters for type layer
    3. Special parameters for search action


Introduction

Maps Marker Pro also offers a complete RESTful API allowing you to access some of the common core functionalities in Maps Marker Pro.

The RESTful API can be accessed via the mmp-api end point of your website:

https://yoursite.com/mmp-api/

It is highly recommended to use https only for accessing the REST API, as otherwise the secret token could be intercepted by third parties while being transmitted in cleartext via http!

In order to access the API, you will need to provide a valid public API key and also a valid token. An API key and token can be generated for any user by going to Maps Marker Pro → Maps Marker APIs.


Authentication

For every request you make, you must provide two parameters in order to be authenticated to use the API, which are public_key and secret_token. The Secret Key is used for internal authentication. Thus, it should not be publicly available or used to access the API.

Both the public API key and the secret token need to be appended to the URL as query parameters, like so:

https://yoursite.com/mmp-api/?public_key=<API key here>&secret_token=<token here>


Testing the API

To test the API, you can use this useful Chrome extension. It's called "PostMan". You can add it to your Chrome browser from here. It's a A fantastic tool, excellent for debugging and testing APIs.


Response Format

The default API response format is JSON

The API also supports XML format. To change the format, you have to provide the format parameter to xml as following:

https://yoursite.com/mmp-api/?public_key=<API key here>&secret_token=<token here>&format=xml


Endpoints

The main endpoints of the API are distributed between the main elements of the plugin: marker and layers.

The rest of the documentation will cover these endpoints and will provide usage examples.


Markers

Get Marker

lmm-api/markers/get

Returns the marker object for a given Marker ID.

Parameters

  • marker_id integer

    The ID of the Marker.

  • The response given by the MMP API is available in two formats:
    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/get/?marker_id=100&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "id": "115",
        "markername": "Vienna",
        "basemap": "googleLayer_roadmap",
        "layer": "[\"0\"]",
        "lat": "48.208174",
        "lon": "16.373819",
        "icon": "",
        "popuptext": "Vienna City",
        "zoom": "10",
        "openpopup": "0",
        "mapwidth": "640",
        "mapwidthunit": "px",
        "mapheight": "480",
        "panel": "1",
        "createdby": "admin",
        "createdon": "2015-11-28 20:28:51",
        "updatedby": "admin",
        "updatedon": "2016-01-26 22:02:53",
        "controlbox": "1",
        "overlays_custom": "0",
        "overlays_custom2": "0",
        "overlays_custom3": "0",
        "overlays_custom4": "0",
        "wms": "0",
        "wms2": "0",
        "wms3": "0",
        "wms4": "0",
        "wms5": "0",
        "wms6": "0",
        "wms7": "0",
        "wms8": "0",
        "wms9": "0",
        "wms10": "0",
        "kml_timestamp": null,
        "address": "Vienna, Austria",
        "gpx_url": "",
        "gpx_panel": "0"
    }
    

    Sample XML Response

    <mmp>
        <id>115</id>
        <markername>Vienna</markername>
        <basemap>googleLayer_roadmap</basemap>
        <layer>["0"]</layer>
        <lat>48.208174</lat>
        <lon>16.373819</lon>
        <icon></icon>
        <popuptext><p>Vienna City</p></popuptext>
        <zoom>10</zoom>
        <openpopup>0</openpopup>
        <mapwidth>640</mapwidth>
        <mapwidthunit>px</mapwidthunit>
        <mapheight>480</mapheight>
        <panel>1</panel>
        <createdby>admin</createdby>
        <createdon>2015-11-28 20:28:51</createdon>
        <updatedby>admin</updatedby>
        <updatedon>2016-01-26 22:02:53</updatedon>
        <controlbox>1</controlbox>
        <overlays_custom>0</overlays_custom>
        <overlays_custom2>0</overlays_custom2>
        <overlays_custom3>0</overlays_custom3>
        <overlays_custom4>0</overlays_custom4>
        <wms>0</wms>
        <wms2>0</wms2>
        <wms3>0</wms3>
        <wms4>0</wms4>
        <wms5>0</wms5>
        <wms6>0</wms6>
        <wms7>0</wms7>
        <wms8>0</wms8>
        <wms9>0</wms9>
        <wms10>0</wms10>
        <kml_timestamp></kml_timestamp>
        <address>Vienna, Austria</address>
        <gpx_url></gpx_url>
        <gpx_panel>0</gpx_panel>
    </mmp>
    
    back to top

    Add Marker

    lmm-api/markers/add

    Adds a new marker using the given marker data. Attention: a check is done to make sure it's valid marker data.

    Parameters

    Data of the marker, Available parameters for type marker

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/add/?markername=Vienna+City&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "marker_id": 298
    }
    

    Sample XML Response

    <mmp>
        <marker_id>298</marker_id>
    </mmp>
    
    back to top

    Add Markers (Bulk)

    lmm-api/markers/add_bulk

    Add markers based on given data objects.

    Parameters

    markers_data Data of the markers, Available parameters for type marker

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/add_bulk/?markers_data[0][markername]=Vienna+City&markers_data[1][markername]=London+City&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "marker_ids": [
            300,
            301
        ]
    }
    

    Sample XML Response

    <mmp>
        <marker_ids>302</marker_ids>
        <marker_ids>303</marker_ids>
    </mmp>
    
    back to top

    Update Marker

    lmm-api/markers/update

    Updates a marker based on given data request.

    Parameters

    Data of the markers, Available parameters for type marker

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/update/?id=105&markername=Berling+City&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "updated": true
    }
    

    Sample XML Response

    <mmp>
        <updated>true</updated>
    </mmp>
    
    back to top

    Update Markers (Bulk)

    lmm-api/markers/update_bulk

    Updates bulk of markers based on given data request.

    Parameters

    markers_data Data of the markers, Available parameters for type marker

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/update_bulk/?markers_data[0][id]=100&markers_data[0][markername]=Vienna+City&markers_data[1][id]=101&markers_data[1][markername]=London+City&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "update_results": {
            "230": true,
            "231": true
        }
    }
    

    Sample XML Response

    <mmp>
        <update_results marker_id="230">true</update_results>
        <update_results marker_id="231">true</update_results>
    </mmp>
    
    back to top

    Delete Marker

    lmm-api/markers/delete

    Delete a marker based on given id.

    Parameters

    marker_id The id of the marker to be deleted

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/delete/?marker_id=100&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "deleted": true
    }
    

    Sample XML Response

    <mmp>
        <deleted>true</deleted>
    </mmp>
    
    back to top

    Delete Markers (Bulk)

    lmm-api/markers/delete_bulk

    Delete bulk of markers based on given IDs.

    Parameters

    markers_ids An array that contains the IDs of markerts to delete.

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/delete_bulk/?marker_ids[]=100&marker_ids[]=101&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "deleted": true
    }
    

    Sample XML Response

    <mmp>
        <deleted>true</deleted>
    </mmp>
    
    back to top

    Search Markers

    lmm-api/markers/search

    Search markers based on given search key and value.

    Parameters

    searchkey The possible values of the search key, Special parameters for search action.

    searchvalue The value of the search key.

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/search/?searchkey=markername&searchvalue=Vienna+City&public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "results": [
            {
                "id": "298",
                "markername": "Vienna City",
                "basemap": "osm_mapnik",
                "layer": "[\"0\"]",
                "lat": "48.216038",
                "lon": "16.378984",
                "icon": "",
                "popuptext": "",
                "zoom": "11",
                "openpopup": "0",
                "mapwidth": "640",
                "mapwidthunit": "px",
                "mapheight": "480",
                "panel": "1",
                "createdby": "MapsMarker API",
                "createdon": "2016-01-26 22:43:54",
                "updatedby": "MapsMarker API",
                "updatedon": "2016-01-26 22:43:54",
                "controlbox": "1",
                "overlays_custom": "0",
                "overlays_custom2": "0",
                "overlays_custom3": "0",
                "overlays_custom4": "0",
                "wms": "0",
                "wms2": "0",
                "wms3": "0",
                "wms4": "0",
                "wms5": "0",
                "wms6": "0",
                "wms7": "0",
                "wms8": "0",
                "wms9": "0",
                "wms10": "0",
                "kml_timestamp": null,
                "address": "",
                "gpx_url": "",
                "gpx_panel": "0"
            },
        ]
    }
    

    Sample XML Response

    <mmp>
        <results>
            <id>298</id>
            <markername>Vienna City</markername>
            <basemap>osm_mapnik</basemap>
            <layer>["0"]</layer>
            <lat>48.216038</lat>
            <lon>16.378984</lon>
            <icon></icon>
            <popuptext></popuptext>
            <zoom>11</zoom>
            <openpopup>0</openpopup>
            <mapwidth>640</mapwidth>
            <mapwidthunit>px</mapwidthunit>
            <mapheight>480</mapheight>
            <panel>1</panel>
            <createdby>MapsMarker API</createdby>
            <createdon>2016-01-26 22:43:54</createdon>
            <updatedby>MapsMarker API</updatedby>
            <updatedon>2016-01-26 22:43:54</updatedon>
            <controlbox>1</controlbox>
            <overlays_custom>0</overlays_custom>
            <overlays_custom2>0</overlays_custom2>
            <overlays_custom3>0</overlays_custom3>
            <overlays_custom4>0</overlays_custom4>
            <wms>0</wms>
            <wms2>0</wms2>
            <wms3>0</wms3>
            <wms4>0</wms4>
            <wms5>0</wms5>
            <wms6>0</wms6>
            <wms7>0</wms7>
            <wms8>0</wms8>
            <wms9>0</wms9>
            <wms10>0</wms10>
            <kml_timestamp></kml_timestamp>
            <address></address>
            <gpx_url></gpx_url>
            <gpx_panel>0</gpx_panel>
        </results>
    </mmp>
    
    back to top

    Count Markers

    lmm-api/markers/count

    Returns the number of markers available.

    Parameters

    No special parameters are required.

    The response given by the MMP API is available in two formats:

    • JSON (default)
    • XML

    To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

    Usage Example

    
    https://yoursite.com/mmp-api/markers/count/?public_key=<API key here>&secret_token=<token here>&format=json
    

    Sample JSON Response

    {
        "markers_count": 173
    }
    

    Sample XML Response

    <mmp>
        <markers_count>173</markers_count>
    </mmp>
    
    back to top


    Layers

    Get Marker

    lmm-api/layers/get

    Returns the layer object for a given Layer ID.

    Parameters

    • layer_id integer

      The ID of the layer.

    • The response given by the MMP API is available in two formats:
      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/get/?layer_id=100&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "id": "197",
          "name": "C1",
          "basemap": "googleLayer_roadmap",
          "layerzoom": "11",
          "mapwidth": "100",
          "mapwidthunit": "%",
          "mapheight": "300",
          "panel": "1",
          "layerviewlat": "37.986534",
          "layerviewlon": "23.381608",
          "createdby": "admin",
          "createdon": "2016-01-06 17:07:47",
          "updatedby": "admin",
          "updatedon": "2016-01-20 21:22:43",
          "controlbox": "1",
          "overlays_custom": "0",
          "overlays_custom2": "0",
          "overlays_custom3": "0",
          "overlays_custom4": "0",
          "wms": "0",
          "wms2": "0",
          "wms3": "0",
          "wms4": "0",
          "wms5": "0",
          "wms6": "0",
          "wms7": "0",
          "wms8": "0",
          "wms9": "0",
          "wms10": "0",
          "listmarkers": "0",
          "multi_layer_map": "0",
          "multi_layer_map_list": "0",
          "address": "",
          "clustering": "0",
          "gpx_url": "",
          "gpx_panel": "0"
      }
      

      Sample XML Response

      <mmp>
          <id>197</id>
          <name>C1</name>
          <basemap>googleLayer_roadmap</basemap>
          <layerzoom>11</layerzoom>
          <mapwidth>100</mapwidth>
          <mapwidthunit>%</mapwidthunit>
          <mapheight>300</mapheight>
          <panel>1</panel>
          <layerviewlat>37.986534</layerviewlat>
          <layerviewlon>23.381608</layerviewlon>
          <createdby>admin</createdby>
          <createdon>2016-01-06 17:07:47</createdon>
          <updatedby>admin</updatedby>
          <updatedon>2016-01-20 21:22:43</updatedon>
          <controlbox>1</controlbox>
          <overlays_custom>0</overlays_custom>
          <overlays_custom2>0</overlays_custom2>
          <overlays_custom3>0</overlays_custom3>
          <overlays_custom4>0</overlays_custom4>
          <wms>0</wms>
          <wms2>0</wms2>
          <wms3>0</wms3>
          <wms4>0</wms4>
          <wms5>0</wms5>
          <wms6>0</wms6>
          <wms7>0</wms7>
          <wms8>0</wms8>
          <wms9>0</wms9>
          <wms10>0</wms10>
          <listmarkers>0</listmarkers>
          <multi_layer_map>0</multi_layer_map>
          <multi_layer_map_list>0</multi_layer_map_list>
          <address></address>
          <clustering>0</clustering>
          <gpx_url></gpx_url>
          <gpx_panel>0</gpx_panel>
      </mmp>
      
      back to top

      Add Layer

      lmm-api/layers/add

      Adds a new layer using the given Layer data. Attention: a check is done to make sure it's valid marker data.

      Parameters

      Data of the layer, Available parameters for type layer

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/add/?name=Vienna+City&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "layer_id": 298
      }
      

      Sample XML Response

      <mmp>
          <layer_id>298</marker_id>
      </mmp>
      
      back to top

      Add Layers (Bulk)

      lmm-api/layers/add_bulk

      Add layers based on given data objects.

      Parameters

      layers_data Data of the layers, Available parameters for type layer

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/add_bulk/?layers_data[0][name]=Vienna+Cafes&layers_data[1][name]=London+Cafes&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "layer_ids": [
              300,
              301
          ]
      }
      

      Sample XML Response

      <mmp>
          <layer_ids>302</layer_ids>
          <layer_ids>303</layer_ids>
      </mmp>
      
      back to top

      Update Layers

      lmm-api/layers/update

      Updates a layer based on given data request.

      Parameters

      Data of the layers, Available parameters for type layer

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/update/?id=105&name=Berlin+City&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "updated": true
      }
      

      Sample XML Response

      <mmp>
          <updated>true</updated>
      </mmp>
      
      back to top

      Update Layers (Bulk)

      lmm-api/layers/update_bulk

      Updates bulk of layers based on given data request.

      Parameters

      layers_data Data of the layers, Available parameters for type layer

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/update_bulk/?layers_data[0][id]=100&layers_data[0][name]=Vienna+Cafes&layers_data[1][id]=101&layers_data[1][name]=London+Cafes&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "update_results": {
              "230": true,
              "231": true
          }
      }
      

      Sample XML Response

      <mmp>
          <update_results layer_id="230">true</update_results>
          <update_results layer_id="231">true</update_results>
      </mmp>
      
      back to top

      Delete Layer

      lmm-api/layers/delete

      Delete a layer based on given id.

      Parameters

      layer_id The id of the layer to be deleted

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/delete/?layer_id=100&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "deleted": true
      }
      

      Sample XML Response

      <mmp>
          <deleted>true</deleted>
      </mmp>
      
      back to top

      Delete Layers (Bulk)

      lmm-api/layers/delete_bulk

      Delete bulk of layers based on given IDs.

      Parameters

      layers_ids An array contains the IDs of the layers to delete.

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/delete_bulk/?layers_ids[]=100&layers_ids[]=101&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "deleted": true
      }
      

      Sample XML Response

      <mmp>
          <deleted>true</deleted>
      </mmp>
      
      back to top

      Search Layers

      lmm-api/layers/search

      Search layers based on given search key and value.

      Parameters

      searchkey The possible values of the search key, Special parameters for search action.

      searchvalue The value of the search key.

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/search/?searchkey=name&searchvalue=Vienna&public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "results": [
              {
                  "id": "197",
                  "name": "Vienna City",
                  "basemap": "googleLayer_roadmap",
                  "layerzoom": "11",
                  "mapwidth": "100",
                  "mapwidthunit": "%",
                  "mapheight": "300",
                  "panel": "1",
                  "layerviewlat": "37.986534",
                  "layerviewlon": "23.381608",
                  "createdby": "admin",
                  "createdon": "2016-01-06 17:07:47",
                  "updatedby": "admin",
                  "updatedon": "2016-01-20 21:22:43",
                  "controlbox": "1",
                  "overlays_custom": "0",
                  "overlays_custom2": "0",
                  "overlays_custom3": "0",
                  "overlays_custom4": "0",
                  "wms": "0",
                  "wms2": "0",
                  "wms3": "0",
                  "wms4": "0",
                  "wms5": "0",
                  "wms6": "0",
                  "wms7": "0",
                  "wms8": "0",
                  "wms9": "0",
                  "wms10": "0",
                  "listmarkers": "0",
                  "multi_layer_map": "0",
                  "multi_layer_map_list": "0",
                  "address": "",
                  "clustering": "0",
                  "gpx_url": "",
                  "gpx_panel": "0"
              }
          ]
      }
      

      Sample XML Response

      
      <mmp>
          <results>
              <id>197</id>
              <name>Vienna City</name>
              <basemap>googleLayer_roadmap</basemap>
              <layerzoom>11</layerzoom>
              <mapwidth>100</mapwidth>
              <mapwidthunit>%</mapwidthunit>
              <mapheight>300</mapheight>
              <panel>1</panel>
              <layerviewlat>37.986534</layerviewlat>
              <layerviewlon>23.381608</layerviewlon>
              <createdby>admin</createdby>
              <createdon>2016-01-06 17:07:47</createdon>
              <updatedby>admin</updatedby>
              <updatedon>2016-01-20 21:22:43</updatedon>
              <controlbox>1</controlbox>
              <overlays_custom>0</overlays_custom>
              <overlays_custom2>0</overlays_custom2>
              <overlays_custom3>0</overlays_custom3>
              <overlays_custom4>0</overlays_custom4>
              <wms>0</wms>
              <wms2>0</wms2>
              <wms3>0</wms3>
              <wms4>0</wms4>
              <wms5>0</wms5>
              <wms6>0</wms6>
              <wms7>0</wms7>
              <wms8>0</wms8>
              <wms9>0</wms9>
              <wms10>0</wms10>
              <listmarkers>0</listmarkers>
              <multi_layer_map>0</multi_layer_map>
              <multi_layer_map_list>0</multi_layer_map_list>
              <address></address>
              <clustering>0</clustering>
              <gpx_url></gpx_url>
              <gpx_panel>0</gpx_panel>
          </results>
      </mmp>
      
      back to top

      Count Layers

      lmm-api/layers/count

      Returns the number of layers available.

      Parameters

      No special parameters are required.

      The response given by the MMP API is available in two formats:

      • JSON (default)
      • XML

      To specify the format returned (JSON will be used if none is specified), simply add the format argument to the URL:

      Usage Example

      
      https://yoursite.com/mmp-api/layers/count/?public_key=<API key here>&secret_token=<token here>&format=json
      

      Sample JSON Response

      {
          "layers_count": 10
      }
      

      Sample XML Response

      <mmp>
          <layers_count>10</markers_count>
      </mmp>
      
      back to top


    Parameters

    Available parameters for type marker

    Parameter Required? Datatype Default value Notes
    idrequiredintegerset automatically when adding a new marker
    markernameoptionalstringNULL
    geocodeoptionalstringNULL value gets geoencoded via Google Places API and overwrites parameter lat, lon and address
    basemap optional predefined basemap IDs - see notes default basemap for new marker (see settings) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbox2, mapbox3, custom_basemap, custom_basemap2, custom_basemap3, empty_basemap
    layer optional integer default layer for new marker (see settings)
    latoptionalfloatdefault location for new marker (see settings) gets overwritten if parameter geocode is used!
    lonoptionalfloatdefault location for new marker (see settings) gets overwritten if parameter geocode is used!
    iconoptionalstring (e.g. bus.png)NULL if NULL, default icon will be used. Please just use the filename of the icon as stated in the example. All icons available in the icon directory (usually /wp-content/uploads/leaflet-maps-marker-icons if you didnt change it in Settings / map defaults / Default values for marker icons) are available for usage.
    popuptextoptionalstringNULL
    zoomoptionalintegerdefault zoom for new marker (see settings)
    openpopupoptionalbooleandefault value for new markers (see settings)
    mapwidthoptionalintegerdefault mapwidth for new markers (see settings)
    mapwidthunitoptionalstringdefault value for new markers (see settings)
    mapheightoptionalintegerdefault mapheight for new markers (see settings)
    paneloptionalbooleandefault value for new markers (see settings)
    createdbyoptionalstringNULL
    createdonoptionaldate (Y-m-d H:i:s)NULL
    updatedbyoptionalstringNULL
    updatedonoptionaldate (Y-m-d H:i:s)date('Y-m-d H:i:s)
    controlboxoptionalbooleandefault value for new markers (see settings)
    overlays_customoptionalbooleandefault value for new markers (see settings)
    overlays_custom2optionalbooleandefault value for new markers (see settings)
    overlays_custom3optionalbooleandefault value for new markers (see settings)
    overlays_custom4optionalbooleandefault value for new markers (see settings)
    wmsoptionalbooleandefault value for new markers (see settings)
    wms2optionalbooleandefault value for new markers (see settings)
    wms3optionalbooleandefault value for new markers (see settings)
    wms4optionalbooleandefault value for new markers (see settings)
    wms5optionalbooleandefault value for new markers (see settings)
    wms6optionalbooleandefault value for new markers (see settings)
    wms7optionalbooleandefault value for new markers (see settings)
    wms8optionalbooleandefault value for new markers (see settings)
    wms9optionalbooleandefault value for new markers (see settings)
    wms10optionalbooleandefault value for new markers (see settings)
    kml_timestampoptionaldate (Y-m-d H:i:s)NULL
    addressoptionalstringNULL gets overwritten if parameter geocode is used!
    gpx_urloptionalstringNULL since v1.2p
    gpx_paneloptionalboolean0 since v1.2p

    back to top


    Available parameters for type layer

    Parameter Required? Datatype Default value Notes
    idrequiredintegerset automatically when adding a new marker
    geocodeoptionalstringNULL value gets geoencoded via Google Places API and overwrites parameter lat, lon and address
    nameoptionalstringNULL
    basemapoptionalpredefined valuesdefault basemap for new layer (see settings) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwien_satellite, mapbox, mapbox2, mapbox3, custom_basemap, custom_basemap2, custom_basemap3, empty_basemap
    layerzoomoptionalintegerdefault zoom for new layer (see settings)
    mapwidthunitoptionalstringdefault value for new layer (see settings)
    mapwidthoptionalintegerdefault mapwidth for new layer (see settings)
    mapheightoptionalintegerdefault mapheight for new layer (see settings)
    paneloptionalbooleandefault value for new layer (see settings)
    layerviewlatoptionalfloatdefault lat for new layer (see settings) gets overwritten if parameter geocode is used!
    layerviewlonoptionalfloatdefault lon for new layer (see settings) gets overwritten if parameter geocode is used!
    createdbyoptionalstringNULL
    createdonoptionaldate (Y-m-d H:i:s)NULL
    updatedbyoptionalstringNULL
    updatedonoptionaldate (Y-m-d H:i:s)date('Y-m-d H:i:s)
    controlboxoptionalbooleandefault value for new layer (see settings)
    overlays_customoptionalbooleandefault value for new layer (see settings)
    overlays_custom2optionalbooleandefault value for new layer (see settings)
    overlays_custom3optionalbooleandefault value for new layer (see settings)
    overlays_custom4optionalbooleandefault value for new layer (see settings)
    wmsoptionalbooleandefault value for new layer (see settings)
    wms2optionalbooleandefault value for new layer (see settings)
    wms3optionalbooleandefault value for new layer (see settings)
    wms4optionalbooleandefault value for new layer (see settings)
    wms5optionalbooleandefault value for new layer (see settings)
    wms6optionalbooleandefault value for new layer (see settings)
    wms7optionalbooleandefault value for new layer (see settings)
    wms8optionalbooleandefault value for new layer (see settings)
    wms9optionalbooleandefault value for new layer (see settings)
    wms10optionalbooleandefault value for new layer (see settings)
    listmarkersoptionalbooleandefault value for new layer (see settings) option to show list of markers below layer maps
    multi_layer_mapoptionalboolean0
    multi_layer_map_listoptionalstring (comma-separated layer-IDs or all)NULL e.g. 1,2,3,4 or all
    addressoptionalstringNULL gets overwritten if parameter geocode is used!
    delete_markersoptionaltrue/falsefalse when used on delete action, also assigned markers are deleted
    clusteringoptionalbooleandefault value for new layer (see settings) available in pro version only
    gpx_urloptionalstringNULL since v1.2p
    gpx_paneloptionalboolean0 since v1.2p


    Special parameters for search action

    ParameterRequired?Data typeNotes
    searchkeyrequiredstringAllowed searchkeys: id, markername, basemap, layer, lat, lon, icon, popuptext, zoom, openpopup, mapwidth, mapwidthunit, mapheight, panel, createdby, createdon, updatedby, updatedon, controlbox, overlays_custom, overlays_custom2, overlays_custom3, overlays_custom4, wms, wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, address, gpx_url, gpx_panel, name, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, multi_layer_map_list, clustering, boundingbox
    searchvaluedependsstring or integergenerally required but optional when using searchkey createdon, updatedon or boundingbox
    date_fromdependsstring (Y-m-d H:i:s)generally optional but required when using searchkey createdon or updatedon
    date_todependsstring (Y-m-d H:i:s)generally optional but required when using searchkey createdon or updatedon
    lat_top_leftdependsfloatval(6)generally optional but required when using searchkey boundingbox
    lon_top_leftdependsfloatval(6)generally optional but required when using searchkey boundingbox
    lat_bottom_rightdependsfloatval(6)generally optional but required when using searchkey boundingbox
    lon_bottom_rightdependsfloatval(6)generally optional but required when using searchkey boundingbox
    back to top