ok.searchRegion(object)

基础库2.0.3开始支持

该方法为高级接口,使用前请联系管理员开通应用调用权限。

行政区划查询。

使用场景:用于查询行政区划信息。可以根据用户输入的搜索条件,帮助用户快速的查找特定的行政区域信息。

参数

Object object

属性 类型 默认值 必填 说明
keyword string 是 检索行政区划关键字。不支持多关键字检索

接口返回值 Object res 的属性

Object res

参数名 类型 说明
code number 响应状态码
data object 成功响应结果
  districts array 检索到的行政区划数组
    code number 行政区划编码
    code string 行政区划名称
    level number 行政区划级别。可选值为:0:全国,1:省份、2:市,3:区/县,4:镇/乡/街道
msg string 响应信息

示例代码

ok.searchRegion({
search: '天河',
}).then(res => {
console.log(res.data);
// {
// districts: [ [Object], [Object], [Object], [Object], [Object], [Object] ]
// }
})
  1. 1. ok.searchRegion(object)
    1. 1.1. 参数
    2. 1.2. 接口返回值 Object res 的属性
    3. 1.3. 示例代码