HC小区接口文档

删除门禁人员接口文档

一、接口名称

删除门禁人员

二、接口描述

用于外系统删除门禁人员功能

三、接口路径

http://{ip}:{port}/iot/api/accessControlFace.deleteAccessControlFace

四、请求方法

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 请求体参数

参数名称 必填 类型 长度 描述
mfId 是 String 64 人员ID
communityId 是 String 30 小区ID

七、返回值

7.1 返回参数

参数名称 必填 类型 长度 描述
code 是 int 11 返回编号,0 成功 其他失败
msg 是 String 250 描述信息

八、示例请求

{
  "mfId": "22",
  "communityId": "2022081539020475"
}

九、示例响应

{
  "code": 0,
  "msg": "成功"
}

十、业务逻辑说明

  1. 接口会先验证请求参数中必须包含mfId和communityId字段
  2. 将请求参数转换为AccessControlFacePo对象
  3. 调用accessControlFaceV1InnerServiceSMOImpl.deleteAccessControlFace方法执行删除操作
  4. 如果删除失败(返回flag<1)则抛出异常
  5. 删除成功返回成功响应

十一、注意事项

  1. 该接口需要事务支持(@Java110Transactional)
  2. 删除操作是物理删除
  3. 接口需要认证和签名验证