GetCapabilities Requests

Feedback


Request parameter

URL request parameters of the GetCapabilities operation are shown in the following table:

Table 1 Main parameters of the GetCapabilities operation request

Request parameter O/M Description
VERSION=version

Mandatory

Request version numbers

SERVICE=WMS

Optional

Service types.

Requests WMS services, and the request type should be set as"WMS".

REQUEST=GetCapabilities

Optional

Request names.

Requests the GetCapabilities operation, and the request name should be set as "GetCapabilities".

FORMAT=MIME_type

Mandatory

Output formats of service metadata.

For a GetCapabilities request, the WMS server supports to have one <Request><GetCapabilities><Format> element value or several <Request><GetCapabilities><Format> element values in service metadata.

The server supports default text/xml formats, and its supports to others are optional.

FORMAT parameters need to be set as complete strings of MIME types. In the HTTP environment, it needs to set MIME types in the HTTP response header Content-type. If the request specifies a format that the server does not support, the server will return default text/xml formats.

UPDATESEQUENCE=string

Mandatory

Serial numbers or strings used for cache control.

This parameter can guarantee the consistency of the cache.

This parameter value can be an integer, conforming to timestamp strings of ISO 8601:2004 formats, or any other strings.

If the server contains UpdateSequence values in metadata, then UpdateSequence values should increase progressively when Capabilities changes (for example, when adding new maps to the service).

SuperMap iServer has not realized this functionality at present.

For the UPDATESEQUENCE parameter, if the client contains this parameter in GetCapabilities request parameters, then the server will respond based on the UPDATESEQUENCE value of service metadata and the UPDATESEQUENCE request value on the client, as shown in the following table:

Table 2 Use of the UPDATESEQUENCE parameter

UPDATESEQUENCE value of request on the client UPDATESEQUENCE value of service metadata Service response
none any Closest service metadata
any none Closest service metadata
equal equal

Exception:

code=CurrentUpdateSequence

lower higher Closest service metadata
higher lower

Exception:

code=InvalidUpdateSequence

Request example

Request methods of the GetCapabilities operation are as follows:

<ServiceRoot>?SERVICE=WMS&VERSION=version&REQUEST=GetCapabilities

ServiceRoot is the service URI root directory. Please see Setting the Service URI.

For example, after the local SuperMap iServer 6R WMS 1.3.0 service is started successfully, the URI of accessing the GetCapabilities operation is:http://localhost:8090/iserver/services/map-world/wms130/WorldMap_Day?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetCapabilities.

Please refer to Response example to see the result.