删除门禁接口文档
一、接口名称
删除门禁
二、接口描述
用于外系统删除门禁功能
三、接口路径
http://{ip}:{port}/iot/api/accessControl.deleteAccessControl
四、请求方法
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 |
七、返回值
7.1 返回参数
| 参数名称 | 必填 | 类型 | 长度 | 描述 |
|---|---|---|---|---|
| code | 是 | int | 11 | 返回编号，0 成功 其他失败 |
| msg | 是 | String | 250 | 描述信息 |
八、示例请求
{
"machineId": "22",
"communityId": "2022081539020475"
}
九、示例响应
{
"code": 0,
"msg": "成功"
}
十、业务逻辑说明
- 接口会先验证请求参数中machineId和communityId是否存在且不为空
- 将请求参数转换为AccessControlPo对象
- 调用IAccessControlV1InnerServiceSMO接口的deleteAccessControl方法删除门禁记录
- 返回操作结果，如果删除失败会抛出CmdException异常
十一、注意事项
- 该接口需要事务支持，操作失败会回滚
- 删除操作需要确保小区ID和设备ID对应记录存在
- 接口需要认证和签名验证