URI

<map_uri>/maritimepcinfo[.<format>]

支持的方法

GETHEAD

父资源

map

介绍

maritimepcinfo 资源用于获取 S100 系列海图(如 S101、S102 等)的图示目录参数信息。不同版本的 S100 海图可能对应不同的图示目录(Portrayal Catalogue),每个目录包含一套完整的出图参数(如安全等深线、颜色模式等)。通过此资源,客户端可以查询当前海图可用的所有图示目录版本,以及每个版本下包含的参数定义(参数名称、ID、类型、默认值、可选项等),从而动态构建出图参数配置界面。

仅当地图服务中包含 S100 标准海图数据时,此资源才返回有效信息;若地图中仅包含 S57 数据,则返回空对象或 404 状态码。

支持的方法:

  • GET:获取 S100 海图的图示目录参数信息列表。
  • HEAD:获取 maritimepcinfo 资源的元数据信息。检查该资源是否存在、参数是否合法,权限是否可以访问。

支持的表述格式:RJSON、JSON、HTML、XML、JSONP、FASTJSON。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiserver 是服务器名,“世界海图” 是地图名({mapName})。

http://supermapiserver:8090/iserver/services/map-chart/rest/maps/世界海图/maritimepcinfo.rjson

GET 请求

获取 S100 海图的图示目录参数信息列表。

响应结构

对 maritimepcinfo 资源执行 GET 请求,返回的是一个 JSON 对象,其键为图示目录版本名称(如 "S101_PC_1.1.1"),值为该版本下的参数列表。单个参数对象的表述结构如下:

字段 类型 说明
name String 参数的显示名称。
id String 参数的唯一标识符(与 tileImage 地图出图请求中 `contextParameters` 使用的键名对应)。
type String 参数值的类型,如 "Double"、"Boolean"、"String"。
defaultValue Object 参数的默认值,类型与 `type` 字段一致。
contextParameterEnums Array 当参数为枚举类型时,此数组列出所有可选项,每个选项包含 `id`(选项值)和 `description`(描述)。若参数非枚举类型,则为 `null`。

示例

对 maritimepcinfo 资源:http://supermapiserver:8090/iserver/services/map-chart/rest/maps/WorldChart/maritimepcinfo.rjson 执行 GET 请求,返回的 rjson 格式的资源描述如下(仅展示部分版本和参数):

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 maritimepcinfo 资源是否存在,参数是否合法,或者客户端是否有权限访问 maritimepcinfo 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 maritimepcinfo 资源是否支持<format>格式的表述。

请参见