HC小区接口文档

HC小区接口文档

API 接口文档：查询单元信息

删除单元
 查询单元
 添加单元
 修改单元

1. 接口名称

查询单元信息

2. 接口描述

用于外部系统查询小区内的单元信息，支持分页查询，并可基于小区ID、楼栋ID进行筛选。

3. 接口路径

GET http://{ip}:{port}/app/unit.queryUnits

4. 请求方法

GET

5. 请求头

参数名称	必填	类型	描述
`user-id`	是	String	用户ID，用于数据权限控制
`Authorization`	是	String	用户认证 Token
`app-id`	是	String	应用ID
`transaction-id`	是	String	请求流水号（1000000000 + YYYYMMDDhhmmss + 6位序列）
`sign`	是	String	签名
`req-time`	是	String	请求时间（YYYYMMDDhhmmss）

6. 请求参数

6.1 查询参数（Query Parameters）

参数名称	必填	类型	描述	示例
`communityId`	是	String	小区ID	`123123`
`floorId`	否	String	楼栋ID	`456456`
`page`	否	Integer	当前页数（默认1）	`1`
`row`	否	Integer	每页行数（默认10）	`10`

7. 返回值

7.1 成功响应（HTTP 200）

返回格式：JSON Array

参数名称	类型	描述	示例
`unitId`	String	单元ID	`"123123"`
`unitNum`	String	单元编号	`"1单元"`
`seq`	Integer	排序号	`1`

7.2 错误响应（HTTP 400/500）

参数名称	类型	描述	示例
`code`	String	错误码	`"1"`
`msg`	String	错误信息	`"请求中未包含communityId信息"`

8. 示例请求

8.1 请求示例

GET http://127.0.0.1:8080/app/unit.queryUnits?communityId=123123&page=1&row=10

8.2 响应示例

[
  {
    "unitId": "123123",
    "unitNum": "1单元",
    "seq": 1
  },
  {
    "unitId": "456456",
    "unitNum": "2单元",
    "seq": 2
  }
]

9. 业务逻辑说明

权限控制：
- 根据 user-id 查询用户可访问的单元列表（dataPrivilegeUnitV1InnerServiceSMOImpl）。
数据查询：
- 根据 communityId 和 floorId 查询单元信息（unitInnerServiceSMOImpl）。
分页处理：
- 支持 page 和 row 参数进行分页查询。

10. 注意事项

必填参数：communityId 必须提供，否则返回错误。
数据权限：仅返回用户有权限访问的单元数据。

文档版本：v1.0
最后更新：2023-10-10