URI
<arcgisrest_uri>/geocode/GeocodeServer[.<format>]
支持的方法
父资源
子资源
findAddressCandidates、geocodeAddresses、reverseGeocode、suggest
介绍
ArcGIS REST 地址匹配服务的根 API 资源,提供有关服务的信息,如服务描述、地址字段、空间参考等。
支持的方法:
HTTP 请求方法
对如下 URI 执行 HTTP 请求,以 json 输出格式为例加以说明,其中,supermapiserver 是服务器名,{component}是服务组件名。
http://supermapiserver:8090/iserver/services/{component}/arcgisrest/geocode/GeocodeServer.json
GET 请求
获取 ArcGIS REST 地址匹配服务服务基本信息 。
请求参数
对 geocodeService 资源执行 GET 请求,获取网络分析服务信息,可以在 URI 中包含如下参数:
名称 | 类型 | 含义 |
---|---|---|
f | String | 响应格式,支持 json、pjson |
响应结构
对 geocodeService 资源执行 GET 请求,返回的资源表述的结构如下 :
字段 | 类型 | 说明 |
---|---|---|
currentVersion | double | 转发的 ArcGIS 服务的版本 |
capabilities | String | 支持的功能,当前支持 Geocode,ReverseGeocode 和 Suggest |
serviceDescription | String | 服务信息描述 |
addressFields | ArcGISAddressFieldInfo[] | 地址的属性字段 |
singleLineAddressField | ArcGISAddressFieldInfo | 单行地址的属性字段,仅当 locator 支持使用单行地址匹配时返回该信息 |
candidateFields | ArcGISAddressFieldInfo[] | 候选匹配项的属性字段 |
intersectionCandidateFields | ArcGISAddressFieldInfo[] | 相交候选匹配项的属性字段 |
spatialReference | ArcGISSpatialReference | 空间参考 |
locatorProperties | LocatorProperties | 从 ArcGIS Pro 发布原始地址匹配服务使用的定位器的属性 |
ArcGISAddressFieldInfo 对象的结构如下:
名称 | 类型 | 含义 |
name | String | 字段名称 |
alias | String | 字段别名 |
required | boolean | 是否为发布服务的必选字段 |
length | int | 字段长度 |
type | String | 字段类型 |
localizedNames | Object | 该字段名称,即 name 字段的参数值在所有支持的语言中本地化名称的映射, 如:{"en-as":"Country"}; |
recognizedNames | Object | 该字段名称,即 name 字段的参数值在所有支持的语言中公识名称的映射, 如:{"en-as":["Country","Country Code","ISO Country Code"]} |
响应示例
对 geocodeService 资源执行 GET 请求:http://supermapiserver:8090/iserver/services/addressmatch-arcgisGeocode/arcgisrest/geocode/GeocodeServer.json,返回 json 格式的资源表述如下:
HEAD 请求
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 geocodeService 资源是否存在,或者客户端是否有权限访问 geocodeService 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 geocodeService 资源是否支持<format>格式的表述。
请参见
- findAddressCandidates、geocodeAddresses、reverseGeocode、suggest
- 客户端构建 REST 请求
- 状态码列表及说明
- SuperMap iServer REST API 表述格式介绍