<map_uri>/trackinglayer[.<format>]
ERROR: Variable (map_link) is undefined.
A child resource of the map resource. By implementing POST on the trackingLayer resource, one can create highlight target sets (the highlightTargetSet resource), which can be used to manage highlight targets. The server can automatically assign an ID to the created highlightTargetSet resource and return its URI. No parameter is necessary.
Supported methods
Supported output formats: rjson, json, html, xml.
Implement the HTTP request on the following URI and return the response in RJSON format. In the URI below, supermapiserver is the name of the server, and WorldMap is the map name ({mapName}).
http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/trackingLayer.rjson
Lists all the highlight target sets.
Field | Type | Definition |
_cache | boolean | [Optional parameters] Whether to use cache, the default is True. False means close all the caches. |
When implementing GET on the trackingLayer resource, the body of the response message is a collection of highlight target sets (the highlightTargetSet resource), where each highlight target set is represented in the following structure:
Name | Type | Description |
name | String | ID of the highlight target set. |
path | String | URI of the highlight target set. |
resourceConfigID | String | ID of the resource configuration. |
resourceType | String | Resource type. |
supportedMediaTypes | String[] | Supported media types for descriptions. |
When implementing GET on the example URI--http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/trackingLayer.rjson, if the highlight target set already exists, it returns the following resource representation in rjson format:
[{
"name": "pcg70k3e_17cacff656b74cca9fce82354cf4b82e",
"path": "http://supermapiserver:8090/iserver/services/map-world/rest/maps/%E4%B8%96%E7%95%8C%E5%9C%B0%E5%9B%BE/trackingLayer/pcg70k3e_17cacff656b74cca9fce82354cf4b82e",
"resourceConfigID": "highlightTargetSet",
"resourceType": "StaticResource",
"supportedMediaTypes": [
"application/xml",
"text/xml",
"application/json",
"application/rjson",
"text/html",
"application/jsonp",
"application/x-java-serialized-object"
]
}]
creates highlight target sets for map resources.
To create highlight target sets for map resources via the POST request and the request body should include the highlight target sets to be added. The structure of every element in the set is as follows:
(When the request body is empty, an empty highlightTargetSet resource will be created.)
Name | Type | Description |
name | String | Name of the highlight target. |
geometries | Geometry[] | Array of highlight geometric targets, that is, the content of the highlight target. |
geometryIDs | int[] | Array of the IDs of the highlight geometric targets. |
style | Style | Style of the highlight target. The same highlight target has a consistent style. |
When implementing POST on the trackingLayer resource, it returns the representation in the following structure (expressed in the body of the response message):
Name | Type | Description |
succeed | boolean | Indicates whether or not the resource creation is successful. If successful, it will return the location of the new resource newResourceLocation; if false, it will return an error message. |
newResourceID | String | ID of the new resource. |
newResourceLocation | String | URI of the newly created highlight target set resource. |
error | HttpError | An error message. If successful, the field will be absent. |
When implementing POST on the trackingLayer resource URI--http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/trackingLayer.rjson to create an empty highlight target set, it returns the following representation in rjson format:
{
"succeed": true,
"newResourceID": "pcg70k3e_17cacff656b74cca9fce82354cf4b82e",
"postResultType": "CreateChild",
"newResourceLocation": "http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/trackingLayer/pcg70k3e_17cacff656b74cca9fce82354cf4b82e.json"
}
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 trackingLayer 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 trackingLayer supports the representation in <format> or not.