3. 开门及记录

API列表

编号 API名称 路径 版本
1.1 开门记录查询 /v1/iot/door/openRecord/doorOpenRecord/queryOpenRecord 1.0
1.2 远程开门 /v1/iot/door/openRecord/doorOpenRecord/openDoor 1.0

API调用

1.1: 开门记录查询

描述 开门记录查询

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/door/openRecord/doorOpenRecord/queryOpenRecord

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 页数
projectId body string y 项目id
deviceOrPerson body string n 设备或人员
openMode body string n 开门方式
startTime body string n 开始时间
endTime body string n 结束时间
doorLockType body array n 门禁类型
personId body string n 访客或者人员id

请求Body描述(非Form表单数据)

{    "pageNo": 1,
    "pageSize": 10,
    "projectId": "23414",
    "personId":"90000001"   
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
success 顶层 boolean 是否成功
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": 1,
            "openMode": "人脸",
            "period": 21,
            "projectId": 21441121,
            "personName": "卢彰振",
            "openTime": "2020-09-04 21:21:51",
            "openResult": "1",
            "deviceId": 1,
            "deviceName": "捷顺-门禁",
            "doorLockType": "",
            "openResult": "开门结果",
            "personType":"用户类型",
            "type": "开门类型",
            "personPhone":"用户电话号码"
        }
    ]
}

1.2: 远程开门

描述 远程开门

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/openRecord/doorOpenRecord/openDoor

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id
deviceId body int y 设备id
personId body string y 人员id ,访客 开门的话,这里传拜访人的id
personType body int y 人员种类 1住户 2员工 3访客 4其他
visitorId body int n 人员类型为访客的时候,传入访客id

请求Body描述(非Form表单数据)

{
    "projectId": "21441121",
    "deviceId": "1",
    "personId": "1",
    "personType": "1",
    "visitorId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
data 顶层 boolean y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
       "is_online": true
    }

results matching ""

    No results matching ""