接口名字
- 接口：common/city/fuzzySearch
- Method：GET
- 数据格式：JSON
- 限流信息：3000次/小时
- 接口说明：此接口可以基于城市名字搜索云简的城市code。云简的城市code在确定后不会修改，因此查询的数据均可以缓存，只有出先新的城市时，需要重复查询。或者基于员工填写的数据搜索城市。
- 变更历史
参数:
请求参数
| 字段名称 |
字段类型 |
是否必填 |
长度限制(字节) |
字段描述 |
| bizId |
String |
TRUE |
64 |
业务唯一识别码 |
| timestamp |
Long |
TRUE |
13 |
13位时间戳，会基于此字段做有效性校验，如果与云简系统服务器时间差超过10分钟，会被认为无效请求 |
| search_text |
String |
TRUE |
64 |
模糊查询的关键字 |
| page_num |
Integer |
FALSE |
10 |
不传默认为1，原则上模糊搜索也不需要查询第二页 |
| page_size |
Integer |
FALSE |
10 |
不传默认为20，传入值也不可超过100 |
返回参数
| 字段名称 |
字段类型 |
长度限制(字节) |
字段描述 |
| resCode |
Integer |
16 |
响应状态码参考附录二 响应状态码 |
| resMsg |
String |
255 |
响应描述信息 |
| data |
JSON |
|
响应实体信息 |
| data.page_size |
Integer |
|
每页条数 |
| data.page_num |
Integer |
|
当前页 |
| data.total_count |
Integer |
|
总条数 |
| data.page_info |
List |
|
总条数 |
| data.page_info[*].hot |
Integer |
|
热度，排序时越大越靠前，公司有自定义的是自定义的，没有自定义的按标准产品的 |
| data.page_info[*].language |
String |
|
语言 |
| data.page_info[*].description |
String |
|
城市描述 |
| data.page_info[*].city_code |
String |
|
城市描述 |
| data.page_info[*].city_name |
String |
|
城市描述 |
| data.page_info[*].city_type |
String |
|
城市分类，是公司自定义的，没有自定义的按标准产品的 |
| data.page_info[*].region_code |
String |
|
地区代码 |
| data.page_info[*].region_name |
String |
|
地区名字 |
| data.page_info[*].nationality_code |
String |
|
国家代码 |
| data.page_info[*].nationality_name |
String |
|
国家名字 |
| data.page_info[*].enabled_flag |
String |
|
城市是否启用 |
| data.page_info[*].is_customizable |
booleon |
|
是否是客户自定义城市，true代表是公司自定义城市，false代表是标准城市 |
示例：
请求数据
https:
返回数据
{
"resCode": 200000,
"resMsg": "success",
"data": {
"page_size": 20,
"page_num": 1,
"total_count": 1,
"total_page": 0,
"is_first_page": true,
"is_last_page": false,
"page_info": [
{
"hot": 100,
"description": "上海市",
"language": "zh_CN",
"city_code": "上海",
"city_name": "上海市",
"city_type": "",
"region_code": "CN2",
"region_name": "上海市",
"nationality_code": "CHN",
"nationality_name": "中国",
"enabled_flag": "Y",
"is_customizable": false
}
]
}
}
变更历史
| 变更日期 |
变更人 |
变更描述 |
| 2025-04-11 |
陈波 |
新增接口 |