修改门禁接口文档
一、接口名称
修改门禁信息
二、接口描述
用于外部系统修改门禁设备的基本信息，包括位置、监控设备关联等配置。
三、接口路径
http://{ip}:{port}/iot/api/accessControl.UpdateAccessControl
四、请求方法
POST
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token Base token 通过登录接口获取token |
| app-id | 是 | String | 应用ID 系统dev账户分配 |
| transaction-id | 是 | String | 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间 YYYYMMDDhhmmss |
六、请求参数
6.1 请求体参数
| 参数名称 | 必填 | 类型 | 长度 | 描述 |
|---|---|---|---|---|
| machineId | 是 | String | 64 | 门禁设备编号 |
| communityId | 是 | String | 30 | 小区ID |
| locationId | 否 | String | - | 位置ID，如果提供会验证位置是否存在 |
| monitorId | 否 | String | - | 监控设备ID，如果提供且不为"-1"会验证监控设备是否存在 |
七、返回值
7.1 返回值结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | int | 返回码，0表示成功，其他表示失败 |
| msg | String | 返回信息描述 |
八、业务逻辑说明
参数验证：
- 必须包含machineId和communityId
- 如果提供了locationId，会验证该位置是否存在
- 如果提供了monitorId且不为"-1"，会验证该监控设备是否存在
数据更新：
- 将请求参数转换为AccessControlPo对象
- 调用accessControlV1InnerServiceSMOImpl.updateAccessControl方法更新门禁信息
- 返回操作结果
九、数据库操作
- 查询设备位置信息（如果提供了locationId）
- 查询监控设备信息（如果提供了monitorId）
- 更新门禁设备信息
十、示例请求
{
"machineId": "22",
"communityId": "2022081539020475",
"locationId": "123",
"monitorId": "456"
}
十一、示例响应
{
"code": 0,
"msg": "成功"
}
十二、错误码说明
| 错误码 | 描述 |
|---|---|
| 非0 | 更新数据失败 |
| - | 设备位置不存在 |
| - | 监控设备不存在 |
十三、注意事项
- 该接口需要事务支持（@Java110Transactional注解）
- 如果更新失败会抛出CmdException异常
- 位置名称和监控设备名称会自动从关联表中查询并更新