API接口文档：查询楼栋信息
一、接口名称
查询楼栋信息
二、接口描述
用于外部系统查询小区内的楼栋信息，支持分页查询。
三、接口路径
http://{ip}:{port}/app/floor.queryFloors
四、请求方法
GET
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
Authorization |
是 | String |
用户认证Token（Base Token），通过登录接口获取 |
app-id |
是 | String |
应用ID，由系统分配 |
transaction-id |
是 | String |
请求流水号，格式：1000000000+YYYYMMDDhhmmss+6位序列 |
sign |
是 | String |
签名 |
req-time |
是 | String |
请求时间，格式：YYYYMMDDhhmmss |
六、请求参数
6.1 查询参数（Query Parameters）
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
communityId |
是 | String |
小区ID | 123123 |
page |
是 | int |
当前页码（从1开始） | 1 |
row |
是 | int |
每页记录数 | 10 |
七、返回值
7.1 返回数据结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
code |
int |
返回码，0 表示成功，其他值表示失败 |
msg |
String |
返回信息，如 "成功" 或错误信息 |
apiFloorDataVoList |
Array<Object> |
楼栋数据列表 |
total |
int |
总记录数 |
records |
int |
总页数 |
7.2 apiFloorDataVoList 结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
floorId |
String |
楼栋ID |
floorNum |
String |
楼栋编号 |
八、示例请求
8.1 请求示例
GET http://127.0.0.1:8080/app/floor.queryFloors?page=1&row=10&communityId=123123
8.2 请求头示例
{
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"app-id": "micro-community",
"transaction-id": "100000000020230101120000000001",
"sign": "a1b2c3d4e5f6g7h8i9j0",
"req-time": "20230101120000"
}
九、示例响应
9.1 成功响应
{
"code": 0,
"msg": "成功",
"apiFloorDataVoList": [
{
"floorId": "123123",
"floorNum": "1号楼"
},
{
"floorId": "123124",
"floorNum": "2号楼"
}
],
"total": 2,
"records": 1
}
9.2 错误响应
{
"code": 1001,
"msg": "小区ID不能为空"
}
十、业务逻辑说明
- 参数校验：检查
communityId、page、row是否有效。 - 查询逻辑：
- 调用
IFloorInnerServiceSMO.queryFloorsCount获取总记录数。 - 调用
IFloorInnerServiceSMO.queryFloors获取楼栋列表。
- 调用
- 分页计算：根据
total和row计算总页数records。
十一、数据库操作
- 查询
hc_floor表，获取楼栋信息。 - 使用
communityId作为查询条件。
文档版本：1.0
最后更新：2023-10-01
作者：吴学文