门禁出入口

更新时间:2022-12-02 07:07:14下载pdf

API 列表

请求方式 API 描述
GET /v1.0/iot-02/building/access-control-channels 获取门禁出入口列表
POST /v1.0/iot-02/building/access-control-channels/actions/issue-commands 向出入口下发指令
POST /v1.0/iot-02/building/access-controls/actions/edit-channels 编辑出入口

获取门禁出入口列表

功能描述

获取门禁出入口列表。

接口地址

GET /v1.0/iot-02/building/access-control-channels

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlName String body 门禁名称(门禁设备名称)
ipAddress String body IP 地址
deviceMac String body 设备 Mac 地址
cid String body 设备 cid S/N
deviceSn String body 序列号
deviceStatus Integer body 设备状态(0-离线,1-在线)
accessControlChannelName String body 出入口名称
roomId String body 区域 ID
containSub boolean body 包含下级区域
page Integer body 页数
pageSize Integer body 页大小

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

{
  "total": "int",
  "list": [
    {
      "projectId": "String //项目 ID",
      "accessControlId": "String //门禁 ID",
      "accessControlChannelId": "String //门禁出入口 ID",
      "accessControlChannelName": "String //门禁出入口名称",
      "accessControlName": "String //门禁名称",
      "accessControlChannelNo": "String //通道号",
      "roomId": "String //门禁出入口安装空间 ID",
      "positionPath": "String //门禁出入口安装位置",
      "deviceId": "String //设备 ID",
      "deviceStatus": "int //设备状态"
    }
  ]
}

请求示例

{
  "accessControlChannelName": "出入口名称",
  "containSub": "包含下级区域",
  "accessControlName": "门禁名称(门禁设备名称)",
  "ipAddress": "IP 地址",
  "deviceMac": "设备 Mac 地址",
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID",
  "deviceSn": "序列号",
  "roomId": "区域 ID",
  "cid": "设备 cid S/N",
  "deviceStatus": "设备状态(0-离线,1-在线)"
}

响应示例

{
  "total": "int",
  "list": [
    {
      "list": "设备状态"
    }
  ]
}

向出入口下发指令

功能描述

向出入口下发指令。

接口地址

POST /v1.0/iot-02/building/access-control-channels/actions/issue-commands

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlChannelIds String[] body 通道 ID
commandType Integer body 命令类型(1-远程开门)
deviceId String body 设备 ID
channelNums String[] body 通道号

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
  "commandType": "命令类型(1-远程开门)",
  "channelNums": "通道号",
  "accessControlChannelIds": "通道 ID",
  "projectId": "项目 ID",
  "deviceId": "设备 ID"
}

响应示例

boolean{}

编辑出入口

功能描述

编辑出入口。

接口地址

POST /v1.0/iot-02/building/access-controls/actions/edit-channels

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID
accessControlId String body 门禁 ID
accessControlChannelId String body 门禁出入口 ID
accessControlChannelNo String body 出入口通道号
accessControlChannelName String body 门禁出入口名称
roomId String body 门禁出入口安装空间 ID

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功。
  • true:成功
  • false:失败
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 返回结果

result 参数说明

boolean{}

请求示例

{
  "accessControlChannelName": "门禁出入口名称",
  "accessControlChannelId": "门禁出入口 ID",
  "accessControlChannelNo": "出入口通道号",
  "projectId": "项目 ID",
  "accessControlId": "门禁 ID",
  "roomId": "门禁出入口安装空间 ID"
}

响应示例

boolean{}

错误码

以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

错误码 说明
500 系统错误