allBlankregions

URI

<blankRegions uri>/all[.<format>]

Supported methods

GET and HEAD

Parent resource

blankRegions

Introduction

Lists all blank region information list of the specified tile task. Filtering according to scales and multi-page are supported.

Supported Methods:

Supported output formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.

http://supermapiserver:8090/iserver/manager/tileservice/jobs/7d59376f-f47a-405b-9862-41ac160b8f23/blankregions/all.rjson

GET request

Gets all blank region information list of the specified tile task. The request parameters must be placed in URI.

Request parameter

Name Type Description
scale double [Required]
The display scale of the map.
fromIndex int [Optional]
Returned starting index of the query result.
toIndex int [Optional]
Returned ending index of the query result.

Response structure

Suppose we implement the GET request on the allBlankregions resource to return the BlankRegion[] field indicating the list of all blank regions, the structure of the BlankRegion[] field is as follows:

Field Type Description
blankRegionId String The ID of all bland regions.
center Point2D The center point for map display.
id int The ID of the geometric object.
markType MarkType The type of the marked blank region. INVALID indicates blank regions. VALID indicates normal regions. NONE indicates the blank region is unmarked.
parts int[] The numbers of vertices contained by child objects of the geometric object.
points Point2D[] The array of 2D coordinates of vertices composing the geometric object.
style Style The style of the geometry object.
type GeometryType The type of the geometry object.
 

Response example

The returned rjson format representation after implementing the GET request on the allBlankregions resource http://localhost:8090/iserver/manager/tileservice/jobs/7d59376f-f47a-405b-9862-41ac160b8f23/blankregions/all.rjson?scale=8.333333333333333e-7&fromIndex=0&toIndex=5 is as follows:

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.

HEAD request can be used to check if the allBlankregions resource exists, or if the allBlankregions resource can be accessed by clients. It can also determine if the allBlankregions resource supports an output format <format> if performed on a URI with .<format> included.

See