URI

<map_uri_>/map[.<format>]

Supported Methods

GET, PUT, HEAD

Parent Resource

map

Description

The WebMap resource is the content resource of a map.

Supported Methods:

  • GET: Get the content of a specified map.
  • PUT: Modify the content of a specified map.
  • HEAD: Check whether the WebMap resource exists or whether the permissions allow access to the WebMap resource.

Supported output formats: RJSON, JSON.

Resource hierarchy

HTTP Request Methods

Perform HTTP requests on the following URI. The rjson output format is used as an example, where supermapiportal is the server name.

http://supermapiportal:8190/iportal/web/maps/{id}/map.rjson

GET Request

Get the content of a specified map.

Response Structure

Perform a GET request on the WebMap resource. The returned RJSON representation of map content conforms to the WebMap specification. For more information about WebMap, see: WebMap Specification Provided by SuperMap.

Property Description
title The name of the map.
description The map description.
extent The extent of the map.
level The zoom level of the map.
center The center point of the map.
baseLayer The base layer information of the map.
layers The layer information of the map.
projection The projection coordinate system of the map.
version The version number of the map.

Response Example

Perform a GET request on the WebMap resource: http://localhost:8190/iportal/web/maps/3/map.rjson. The rjson format response is as follows:

{

    "extent": {

        "leftBottom": {

            "x": 7851611.545458,

            "y": 2436200.9655012

        },

        "rightTop": {

            "x": 14896048.07222,

            "y": 6320424.9948408

        }

    },

    "level": 5,

    "center": {

        "x": 11373829.808839,

        "y": 4378312.980171

    },

    "baseLayer": {

        "layerType": "TILE",

        "visible": true,

        "name": "China",

        "url": "http://localhost:8080/iserver/services/map-china400/rest/maps/China"

    },

    "description": "",

    "projection": "EPSG:3857",

    "title": "China",

    "version": "1.0"

}

PUT Request

Modify the content of a specified map.

Request Parameters

When sending a request, the request body must contain RJSON data that conforms to the WebMap specification. For more information about WebMap, see: WebMap Specification Provided by SuperMap.

Property Description
title The name of the map.
description The map description.
extent The extent of the map.
level The zoom level of the map.
center The center point of the map.
baseLayer The base layer information of the map.
layers The layer information of the map.
projection The projection coordinate system of the map.
version The version number of the map.

Response Structure

The returned resource representation structure is as follows:

Field Type Description
succeed Boolean Whether the map modification was successful.
error HttpError Error information. This field is not returned if the map modification is successful.

Response Example

To modify the map content, perform a PUT request on the WebMap resource: http://localhost:8190/iportal/web/maps/4/map.rjson. The request body is as follows:

{

    "version": "1.0",

    "title": "Untitled Map",

    "description": "",

    "projection": "EPSG:3857",

    "center": {

        "x": 2191602.47499257,

        "y": 4050551.00288805

    },

    "level": 2,

    "extent": {

        "leftBottom": {

            "x": -20037508.3427892,

            "y": -20037508.3427892

        },

        "rightTop": {

            "x": 20037508.3427892,

            "y": 20037508.3427892

        }

    },

    "baseLayer": {

        "layerType": "TIANDITU_VEC_3857",

        "name": "Tianditu",

        "labelLayerVisible": true

    },

    "layers": [

        {

            "layerType": "TILE",

            "name": "China_4326",

            "visible": true,

            "url": "http://localhost:8080/iserver/services/map-china400/rest/maps/China_4326"

        },

        {

            "layerType": "MARKER",

            "name": "Untitled\r\nmarker layer1",

            "visible": true,

            "serverId": "853160733"

        }

    ]

}

The rjson format response is as follows:

{

    "succeed": true

}

HEAD Request

Returns the same HTTP response headers as the GET request, but without the response entity. Metadata information contained in the response headers can be retrieved without transferring the entire response content. Metadata information includes media type, character encoding, compression encoding, entity content length, etc.

A HEAD request can be used to check whether the WebMap resource exists or whether the client has permission to access the WebMap resource. By performing a HEAD request on the URI with .<format> appended, you can also quickly determine whether the WebMap resource supports the <format> format representation.

See