# 查询基础POI

# 列出所有POI集的名称

# 请求 URL:

  • http://host:port/heycloud/api/data/basepoi/list

# 请求方式:

  • GET

# 请求示例:

GET http://host:port/heycloud/api/data/basepoi/list

# 正确响应示例:

{
  "result": ["sample", "china"]
}

# 错误响应示例:

{
  "error": "ERROR",
  "message": "错误信息"
}

# 查询POI

# 请求 URL:

  • http://host:port/heycloud/api/data/basepoi/:poisName/query

# 请求方式:

  • POST |

# 请求参数:

参数名称 类型 是否必须 默认值 说明
poisName String - POI集的名字
search String - 搜索的文本,需至少大于两个非空字符
city String - 限定城市,由POI数据的 city 字段匹配
offset Number 0 返回结果的偏移量,用于分页
limit Number 11 返回结果的数量,用于分页

# 请求示例

POST http://host:port/heycloud/api/data/basepoi/sample/query

{
  "search": "大悦城",
  "city": "北京市",
  "offset": 0,
  "limit": 11
}

# 正确响应示例:

{
  "result": [
    {
      "name": "客梯(朝阳大悦城)",
      "address": "朝阳北路101号朝阳大悦城F10层",
      "city": "北京市",
      "basetype": "室内设施",
      "subtype": "室内设施",
      "category": "室内设施",
      "x": 116.519105,
      "y": 39.924398
    }
  ]
}

# 错误响应示例:

{
  "error": "ERROR",
  "message": "错误信息"
}