URI
<root_uri>/maps[.<format>]
After starting SuperMap iServer, the default URI to access REST map services is http://<server>:8090/iserver/services/map-world/rest/maps.
Supported methods
Parent resource
Child resources
ERROR: Variable (map_link) is undefined.
Introduction
The maps resource includes all the map resources. Through the maps resource, we can get the map information provided by the server.
Please refer to the development guide for more information about this resource usage:Get the map list.
Supported methods
- GET: Gets the map list, including the map name, URI, resource type, etc.
- HEAD: Gets the metadata information about the tile map resource collection. Checks the existence of the maps resource and whether it can be accessed by the client.
Supported output formats:rjson, json, html, xml, jsonp.
GIS Services Resource Hierarchy
http://supermapiserver:8090/iserver/services/map-world/rest/maps.rjson
GET Request
Gets the map list, including the map name, URI, resource type, etc.
Request parameters
| Field | Type | Definition |
| _cache | boolean | [Optional parameters] Whether to use cache, the default is True. False means close all the caches. |
Response structure
When implementing the GET request on the maps resource, in the entity body of the response message is a descriptive set for maps. The representation structure for each map is as follows:
| Name | Type | Description |
| name | String | The map name. |
| path | String | The access path of the map resource. |
| resourceConfigID | String | ID of the resource configuration. |
| resourceType | String | Resource type. |
| supportedMediaTypes | String[] | Supported media types for descriptions. |
Example usage
Implement the GET request on the maps resource and get the response in rjson format, as shown below.
[
{
"name": "World",
"path": "http://localhost:8090/iserver/services/map-world/rest/maps/World",
"resourceConfigID": "map",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object",
"application/ajax",
"application/kml",
"application/ifx",
"application/flex",
"application/isl",
"application/silverlight",
"application/ijs",
"application/javascript",
"application/html5",
"application/smc",
"application/supermapcloud",
"application/tdt",
"application/tianditu",
"application/ilt",
"application/leaflet",
"application/flash3d"
]
},
{
"name": "WorldMap_Day",
"path": "http://localhost:8090/iserver/services/map-world/rest/maps/%E4%B8%96%E7%95%8C%E5%9C%B0%E5%9B%BE_Day",
"resourceConfigID": "map",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object",
"application/ajax",
"application/kml",
"application/ifx",
"application/flex",
"application/isl",
"application/silverlight",
"application/ijs",
"application/javascript",
"application/html5",
"application/smc",
"application/supermapcloud",
"application/tdt",
"application/tianditu",
"application/ilt",
"application/leaflet",
"application/flash3d"
]
},
{
"name": "WorldMap",
"path": "http://localhost:8090/iserver/services/map-world/rest/maps/%E4%B8%96%E7%95%8C%E5%9C%B0%E5%9B%BE",
"resourceConfigID": "map",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object",
"application/ajax",
"application/kml",
"application/ifx",
"application/flex",
"application/isl",
"application/silverlight",
"application/ijs",
"application/javascript",
"application/html5",
"application/smc",
"application/supermapcloud",
"application/tdt",
"application/tianditu",
"application/ilt",
"application/leaflet",
"application/flash3d"
]
},
{
"name": "WorldMap_Night",
"path": "http://localhost:8090/iserver/services/map-world/rest/maps/%E4%B8%96%E7%95%8C%E5%9C%B0%E5%9B%BE_Night",
"resourceConfigID": "map",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object",
"application/ajax",
"application/kml",
"application/ifx",
"application/flex",
"application/isl",
"application/silverlight",
"application/ijs",
"application/javascript",
"application/html5",
"application/smc",
"application/supermapcloud",
"application/tdt",
"application/tianditu",
"application/ilt",
"application/leaflet",
"application/flash3d"
]
},
{
"name": "World Map",
"path": "http://localhost:8090/iserver/services/map-world/rest/maps/World+Map",
"resourceConfigID": "map",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object",
"application/ajax",
"application/kml",
"application/ifx",
"application/flex",
"application/isl",
"application/silverlight",
"application/ijs",
"application/javascript",
"application/html5",
"application/smc",
"application/supermapcloud",
"application/tdt",
"application/tianditu",
"application/ilt",
"application/leaflet",
"application/flash3d"
]
}
]
HEAD request
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.
The HEAD request helps check the existence of the overview maps resource and whether it can be accessed by the client. By implementing the HEAD request on the URI, with .<format> appended to the end, we can quickly get to know whether the maps resource supports the representation in <format> or not.
See
- ERROR: Variable (map_link) is undefined., root
- Constructing REST Requests
- Status Codes
- SuperMap iServer REST API Output Formats
- GIS Services Resource Hierarchy