简要描述(接口未验证):
- 最近的1条行政区或者特定编号的行政区(条件查询待完善)
- 结果里面字段如果数据为null,字段将不显示
- 如果是图片字段,无数据,前端需要显示默认图
- 自定义排序(字段全部小写)参数:orderchild,order
- 【”name”: “北京”, “value”: “110000”】类似格式,value表示库中的ID,name表示前端显示的名称
底下参数根据实际数据库字段进行替换:
_order=img_url:asc|type_name:desc
img_url(数据库字段):asc(升序)|type_name:desc(降序)
_orderchild=[commoditys]img_url:asc
commoditys 对应上级里面包含二级数组的字段
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
v3 | 陈碧贵 | 2022-05-23 | xxxx-xx-xx |
请求URL:
{root_url}/bo/api/v3/{mkey}/detail/res/{resField}?_nodejs=common-data
http://localhost:5900 改成对应接口根地址
https://mall.rg1008.com/bo/api/v3/bo-area/detail/res/view_detail?areaCode=999999&_nodejs=common-data
{mkey} 对应mapper文件
{resField} 对应 {mkey}里面 responseField键
XownerId mxxs
XsysId mxxs-app
请求方式:
- GET
- POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
XownerId | 是 | string | 项目唯一ID,对应bo_project {ownerId} 值: mxxs |
XsysId | 否 | string | 所属系统 对应 bo_system 表 小程序:mxxs-app |
XuserFromFirstShareId | string | 否 | 一级分享用户ID, bo_user user_id |
XuserFromSecondShareId | string | 否 | 二级分享用户ID, bo_user user_id |
XverifyApi | 是 | string | 加密规则encryptByDES(`${newGuid()} |
XfilterAreaCode | 否 | string | 行政区编码, 对应 bo_sys_area area_code |
Content-Type: | 是 | string | application/json; charset=utf-8 请求类型 |
XuserLat | 否 | double | 当前目标纬度 (如果放在地址传递,对应的参数为_userLat) |
XuserLng | 否 | double | 当前目标经度 (如果放在地址传递,对应的参数为_userLng) |
请求参数:
- 当事件发生时,调用http/https接口,传递参数信息,响应请求结果。
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
areaCode | 否 | string | 行政区编码,如果是附近的,传递 999999 |
parentCode | 否 | string | 上级行政区码,如 350000 |
_orderchild | 否 | string | 对商品进行排序 [commoditys]modify_date:desc |
_order | 否 | string | 对门店进行排序 sort_id:asc 如果根据经纬度查询,建议不传递 |
_nodejs | 是 | string | common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
pageSize | 否 | string | 当前显示记录数 |
_userLat | 否 | double | 当前目标纬度 (如果放在头传递,对应的参数为XuserLat) |
_userLng | 否 | double | 当前目标经度 (如果放在头传递,对应的参数为XuserLng) |
_columnAlias | 否 | string | 显示列名 area_code,area_name,其它列 |
levelType | 否 | string | 行政等级数据 [0,1,2,3,4,5] 0是中国 |
返回示例:
正确时返回:
{
"data": {
"lat": {
"name": "39°54′17.960400″",
"value": 39.904989
},
"lng": {
"name": "116°24′19.026000″",
"value": 116.405285
},
"distance": {
"name": "0m",
"value": 0
},
"areaCode": "110100",
"areaName": "北京市",
"shortName": "北京",
"fullName": "北京",
"provinceCode": "11",
"cityCode": "01",
"districtCode": "00",
"pinYin": "BEIJINGSHI",
"jianPin": "BJS",
"firstChar": "B",
"zipCode": "100000",
"diffTableNo": 0,
"areaType": {
"value": "直辖市"
},
"cityVillageCode": {},
"levelType": {
"name": "市级",
"value": 2
},
"parentCode": {
"name": "北京",
"value": "110000"
}
},
"cacheDate": "2022-05-23T06:42:58",
"cacheDateTimestamp": 1653259378940,
"code": "0",
"retCode": "0",
"success": true
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": false,
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
success | bool | true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code | int | 0 表示数据请求成功 |
data | object | |
lng | 经度 | |
lng.value | 经度值 | |
lng.name | 经度名称 | |
lat | 纬度 | |
lat.value | 纬度值 | |
lat.name | 纬度名称 | |
distance | 当前经纬度 距离信息 头里面必须传递 XuserLat/XuserLng 或者 url地址必须传递 userLat/userLng | |
distance.value | 距离值 | |
distance.name | 距离显示名 | |
其它 | 详见数据字典 | |
cacheType | string | redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate | date | 最后数据获取时间 |
数据字典
原始字段 | 小写字段 | 驼峰字段 | 类型 | 主键 | 空 | 默认 | 注释 |
---|---|---|---|---|---|---|---|
AREA_CODE | area_code | areaCode | varchar(15) | 是 | 否 | 行政区划代码,主键,省市县6位,乡镇9位,村12位,自然村15位 | |
PARENT_CODE | parent_code | parentCode | varchar(15) | 否 | 是 | 所属行政区划 | |
AREA_NAME | area_name | areaName | varchar(150) | 否 | 否 | 行政区划名称 | |
SHORT_NAME | short_name | shortName | varchar(150) | 否 | 是 | 简称 如 北京 | |
LNG | lng | lng | double(22) | 否 | 是 | 行政驻地经度 | |
LAT | lat | lat | double(22) | 否 | 是 | 行政驻地纬度 | |
MIN_LNG | min_lng | minLng | double(22) | 否 | 是 | 最小经度 | |
MIN_LAT | min_lat | minLat | double(22) | 否 | 是 | 最小纬度 | |
MAX_LNG | max_lng | maxLng | double(22) | 否 | 是 | 最大经度 | |
MAX_LAT | max_lat | maxLat | double(22) | 否 | 是 | 最大纬度 | |
FULL_NAME | full_name | fullName | varchar(100) | 否 | 是 | 地区全称:省市县乡村自然村 | |
PROVINCE_CODE | province_code | provinceCode | varchar(15) | 否 | 是 | 省级行政区划码 | |
CITY_CODE | city_code | cityCode | varchar(15) | 否 | 是 | 市级行政区划码 | |
DISTRICT_CODE | district_code | districtCode | varchar(15) | 否 | 是 | 县级行政区划码 | |
TOWN_CODE | town_code | townCode | varchar(15) | 否 | 是 | 乡镇行政区划码 | |
VILLAGE_CODE | village_code | villageCode | varchar(15) | 否 | 是 | 行政村行政区划码 | |
IS_ENABLED | is_enabled | isEnabled | int(10) | 否 | 是 | 1 启用 | |
LEVEL_TYPE | level_type | levelType | int(10) | 否 | 是 | 等级 | |
PIN_YIN | pin_yin | pinYin | varchar(200) | 否 | 是 | 拼音 | |
JIAN_PIN | jian_pin | jianPin | varchar(50) | 否 | 是 | 首字母拼音 | |
FIRST_CHAR | first_char | firstChar | varchar(2) | 否 | 是 | 首字母 | |
ZIP_CODE | zip_code | zipCode | varchar(50) | 否 | 是 | 邮编 | |
AREA_TYPE | area_type | areaType | varchar(50) | 否 | 是 | 区域类型[县级市 | |
CITY_VILLAGE_CODE | city_village_code | cityVillageCode | varchar(36) | 否 | 是 | 城乡行政代码 100 城镇 110 -城区 111 –主城区 112 –城乡结合区 120 -镇区 121 –镇中心区 122 –镇乡结合区 123 –特殊区域 200 乡村 210 -乡中心区 220 -村庄 | |
IS_AREA | is_area | isArea | int(10) | 否 | 是 | 行政区 | |
IS_SCENIC | is_scenic | isScenic | int(10) | 否 | 是 | 风景区 | |
IS_HOUSE | is_house | isHouse | int(10) | 否 | 是 | 住宅区 | |
IS_BUSINESS | is_business | isBusiness | int(10) | 否 | 是 | 商业区 | |
REMARK | remark | remark | varchar(4000) | 否 | 是 | 描述 | |
MODIFY_TIME | modify_time | modifyTime | datetime(0) | 否 | 是 | 修改时间 |
文档更新时间: 2022-06-22 11:44 作者:admin