API 接口文档：查询小区列表
1. 接口名称
查询小区列表
2. 接口描述
查询系统中的所有小区信息，支持分页查询、按小区ID筛选等功能。
3. 接口路径
GET http://{ip}:{port}/app/community.listCommunitys
4. 请求方法
GET
5. 请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
Authorization |
是 | String |
用户认证 Token（Base Token，通过登录接口获取） |
app-id |
是 | String |
应用 ID（由系统 dev 账户分配） |
transaction-id |
是 | String |
请求流水号（不能重复，格式：1000000000+YYYYMMDDhhmmss+6位序列） |
sign |
是 | String |
签名 |
req-time |
是 | String |
请求时间（格式：YYYYMMDDhhmmss） |
6. 请求参数
6.1 查询参数（Query Parameters）
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
page |
否 | int |
分页页数（默认：1） | 1 |
row |
否 | int |
每页行数（默认：10） | 10 |
communityId |
否 | String |
小区 ID（精确匹配） | 2022081539020475 |
name |
否 | String |
小区名称（模糊匹配） | 测试小区 |
cityCode |
否 | String |
城市编码 | 630104 |
7. 返回值
7.1 响应格式
{
"code": 0,
"msg": "成功",
"communitys": [
{
"communityId": "2022081539020475",
"name": "测试小区",
"state": "1100",
"stateName": "审核完成",
"cityCode": "630104",
"cityName": "青海省西宁市城西区",
"address": "青海省西宁市城西区国投广场",
"mapX": "101.33",
"mapY": "101.33",
"nearbyLandmarks": "国投广场",
"tel": "18909711443",
"communityAttrDtos": [
{
"attrId": "112022081566950487",
"communityId": "2022081539020475",
"specCd": "9329000004",
"specName": "社区编码",
"value": "123456",
"listShow": "Y",
"statusCd": "0"
}
]
}
],
"page": 1,
"records": 1,
"rows": 10,
"total": 2
}
7.2 响应字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
code |
int |
返回码（0 表示成功，其他表示失败） |
msg |
String |
返回信息 |
communitys |
Array<Object> |
小区列表 |
communitys.communityId |
String |
小区 ID |
communitys.name |
String |
小区名称 |
communitys.state |
String |
小区状态（1100 表示审核完成） |
communitys.cityCode |
String |
城市编码 |
communitys.cityName |
String |
城市名称（省+市+区） |
communitys.address |
String |
小区详细地址 |
communitys.mapX |
String |
经度 |
communitys.mapY |
String |
纬度 |
communitys.nearbyLandmarks |
String |
附近地标 |
communitys.tel |
String |
联系电话 |
communitys.communityAttrDtos |
Array<Object> |
小区扩展属性 |
communityAttrDtos.attrId |
String |
属性 ID |
communityAttrDtos.specCd |
String |
规格编码 |
communityAttrDtos.specName |
String |
规格名称 |
communityAttrDtos.value |
String |
属性值 |
communityAttrDtos.listShow |
String |
是否在列表显示（Y/N） |
communityAttrDtos.statusCd |
String |
状态（0 表示有效） |
page |
int |
当前页码 |
records |
int |
当前页记录数 |
rows |
int |
每页行数 |
total |
int |
总记录数 |
8. 示例请求
8.1 请求示例（查询第1页，每页10条）
GET http://127.0.0.1:8080/app/community.listCommunitys?page=1&row=10
8.2 请求示例（按小区ID查询）
GET http://127.0.0.1:8080/app/community.listCommunitys?communityId=2022081539020475
9. 示例响应
9.1 成功响应
{
"code": 0,
"msg": "成功",
"communitys": [
{
"communityId": "2022081539020475",
"name": "测试小区",
"state": "1100",
"cityCode": "630104",
"cityName": "青海省西宁市城西区",
"address": "青海省西宁市城西区国投广场",
"mapX": "101.33",
"mapY": "101.33",
"nearbyLandmarks": "国投广场",
"tel": "18909711443"
}
],
"page": 1,
"records": 1,
"rows": 10,
"total": 1
}
9.2 错误响应
{
"code": 1001,
"msg": "参数校验失败",
"data": null
}
10. 业务逻辑说明
- 分页查询：支持
page和row参数进行分页查询。 - 小区筛选：支持按
communityId、name、cityCode进行筛选。 - 城市信息关联：根据
cityCode查询关联的省市区信息，并拼接成完整地址。 - 扩展属性：返回小区的扩展属性（如社区编码等）。
11. 数据库操作
- 查询小区表
community - 查询城市区域表
area（关联cityCode） - 查询小区属性表
community_attr（关联communityId）