REST API

GET [root]/maps/[key]

This endpoint returns the full schema details for a single map, based on its key.

Response Type

application/json

Example URL

http://devzone.sites.mapzania.com/mz/maps/AFRICA

Parameters

Name Required Description
key Yes The key of the map. It is also acceptable to set this value to "DEFAULT". In this case, the system setting for default map key is used.
srid No Sets the spatial reference id (SRID) of the map schema. This effectively projects all relevant layer information into the reference system that corresponds with the SRID. If this parameter is not set, it defaults to the display SRID that is defined in the map schema.

Example Results

{
  "type": "Map",
  "key": "AFRICA",
  "displaySRID": "LATLONG",
  "srid": "LATLONG",
  "name": "Africa Map",
  "backColor": "#EDEAE2",
  "backOpacity": 100,
  "backImageUrl": "",
  "removeConflictingLabels": true,
  "layers": [
    {
      "type": "VectorLayer",
      "themes": [
        {
          "type": "Theme",
          "minZoom": 0.0,
          "maxZoom": 30.0,
          "filter": null,
          "labeller": {
            "type": "Labeller",
            "visible": true,
            "field": null,
            "allowDuplicates": false,
            "collisionDetection": false,
            "color": "#000000",
            "fontSize": 10.0,
            "fontFamily": "Arial",
            "bold": false,
            "italic": false,
            "haloColor": "#FFFFFF",
            "haloThickness": 0.0,
            "rotation": 0.0,
            "autoRotate": false,
            "offset": {
              "x": 0.0,
              "y": 0.0
            },
            "visibilityClause": null,
            "collisionBuffer": null,
            "alignment": 0
          },
          "scaleType": 0,
          "field": null,
          "normalizeValues": null,
          "values": [],
          "symbology": 0,
          "symbol": {
            "type": "FillSymbol",
            "pattern": 0,
            "color": "rgb(255, 0, 0)",
            "outline": {
              "type": "CompoundLineSymbol",
              "drawByLayer": true,
              "lines": [
                {
                  "type": "LineSymbol",
                  "pattern": 0,
                  "color": "#000000",
                  "size": 2.0,
                  "endCap": 0,
                  "join": 0,
                  "headSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "tailSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "intervalSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "intervalSymbolSpacing": 10.0,
                  "offset": null
                },
                {
                  "type": "LineSymbol",
                  "pattern": 0,
                  "color": "rgb(255, 255, 255)",
                  "size": 6.0,
                  "endCap": 0,
                  "join": 0,
                  "headSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "tailSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "intervalSymbol": {
                    "type": "CompoundPointSymbol",
                    "drawByLayer": true,
                    "points": []
                  },
                  "intervalSymbolSpacing": 10.0,
                  "offset": null
                }
              ]
            }
          }
        }
      ],
      "fields": [],
      "filter": "Continent==\"Africa\"",
      "highlight": null,
      "cacheLayer": false,
      "tiled": false,
      "scaleType": 0,
      "allowDuplicateLabels": true,
      "vectorServerName": null,
      "vectorLayerGroupName": null,
      "key": "COUNTRIES",
      "name": "Countries of the World",
      "visible": true,
      "sourceKey": "WORLD_SHP",
      "showInLegend": true
    },
    {
      "type": "RasterLayer",
      "opacity": 100,
      "greyScale": true,
      "filter": null,
      "key": "OSM_TILES_GREY",
      "name": "OSM",
      "visible": true,
      "sourceKey": "OSM_TILES",
      "showInLegend": true
    }
  ],
  "startExtent": {
    "type": "Bounds",
    "minX": -34.89,
    "minY": -35.03,
    "maxX": 68.55,
    "maxY": 35.24
  },
  "rotation": {
    "angle": 0.0,
    "originX": 0.0,
    "originY": 0.0
  },
  "scaleType": 0
}