3. 设备API

API列表

编号 API名称
3.1 根据小区id获取门禁列表
3.2 根据小区id获取梯控列表
3.3 门禁开门
3.4 电梯控制
3.5 日立电梯打开实时数据接口
3.6 日立电梯查询实时数据接口

API调用

3.1 根据小区id获取门禁列表

描述

请求信息

URI：/v1/iot/app/device/door/authorization/list

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId param STRING 是 房屋ID
userId header STRING 是 用户ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是
data 顶层 OBJECT 是
message 顶层 STRING 是
equipments data 数组 是 数据
projectId equipments INTEGER 项目id
personId equipments INTEGER 客户id
deviceId equipments STRING 设备id
deviceName equipments STRING 设备名称
mac equipments STRING mac
personName equipments STRING 客户名
phone equipments STRING 客户手机号
customerType equipments INTEGER 客户产权类型2业主 3业主成员 14租户 15租户成员
deviceType equipments INTEGER 设备类型 1大门门禁 2楼栋门禁 3楼栋梯控
joinScopeAuthSpace equipments STRING 空间发布范围(用;号拼接)
joinScopeControlMode equipments STRING 控制方式范围(用;号拼接)
joinScopePersonType equipments STRING 用户类型范围(用;号拼接)

1 设备身份标识：目前拓桥是(序列号¦路数)，其他(自定义编号¦路数)

返回结果示例

{
    "code": 200,
    "data": {
        "equipments": [
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "7d39e324ca42cd6e",
                "deviceName": "这是大华门禁",
                "mac": "21906_1000069_7_0_0",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 2,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely,bluetooth,qrcode",
                "joinScopePersonType": "1,2,3"
            },
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "035e5a2709a1f5bd",
                "deviceName": "【勿删】大华门禁1000012-修改02",
                "mac": "21906_1000012_7_0_0",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 1,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely,qrcode",
                "joinScopePersonType": "1,2,3"
            },
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "edeff7962044605d",
                "deviceName": "大华人梯控H507",
                "mac": "21906_1000047_7_0_0",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 1,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely,bluetooth,qrcode",
                "joinScopePersonType": "1,2,3"
            },
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "837487067a751594",
                "deviceName": "大华测试设备11",
                "mac": "123123",
                "sn": "",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 1,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely,bluetooth,qrcode",
                "joinScopePersonType": "1,2,3"
            }
        ]
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

3.2:根据小区id获取梯控列表

描述

请求信息

URI：/v1/iot/app/device/lift/authorization/list

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId param STRING 是 房屋ID
userId header STRING 是 用户ID

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

{

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是
data 顶层 OBJECT 是
message 顶层 STRING 是
equipments data 数组 是 数据
projectId equipments INTEGER 项目id
personId equipments INTEGER 客户id
deviceId equipments STRING 设备id
deviceName equipments STRING 设备名称
mac equipments STRING mac
personName equipments STRING 客户名
phone equipments STRING 客户手机号
customerType equipments INTEGER 客户产权类型2业主 3业主成员 14租户 15租户成员
deviceType equipments INTEGER 设备类型 1大门门禁 2楼栋门禁 3楼栋梯控
joinScopeAuthSpace equipments STRING 空间发布范围(用;号拼接)
joinScopeControlMode equipments STRING 控制方式范围(用;号拼接)
joinScopePersonType equipments STRING 用户类型范围(用;号拼接)
floorNum equipments INTEGER 楼层

返回结果示例

{
    "code": 200,
    "data": {
        "equipments": [
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "0d5525e260b0c0ee",
                "deviceName": "这是大华梯控",
                "mac": "21906_1000070_ECS_0_0",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 3,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/1栋/A单元,领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely",
                "joinScopePersonType": "1"
            },
            {
                "projectId": 21906,
                "personId": 257437,
                "deviceId": "0d5525e260b0c0ee",
                "deviceName": "这是大华梯控",
                "mac": "21906_1000070_ECS_0_0",
                "personName": "裴珍",
                "phone": "18269242824",
                "customerType": 3,
                "deviceType": 3,
                "joinScopeAuthSpace": "领贤公馆/领片区/建筑物/1栋/A单元,领贤公馆/领片区/建筑物/10栋",
                "joinScopeControlMode": "face,remotely",
                "joinScopePersonType": "1",
                "floorNum": 1
            }
        ]
    },
    "message": "success"
}

3.3:门禁开门

描述

请求信息

URI：v1/iot/app/device/personPassage/door/open

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body Long 是 项目id
personId body Long 是 用户id
deviceId body String 是 设备id

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

{
    "projectId":21906,
    "personId": 257437,
    "deviceId": "7d39e324ca42cd6e"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
openSuccess data BOOLEAN 否 是否成功
errorMsg data STRING 否 失败原因

返回结果示例

{
    "code": 200,
    "data": {
        "openSuccess": false,
        "errorMsg": "当前设备已离线，请联系物业"
    },
    "message": "success"
}

3.4:电梯控制

描述

请求信息

URI：/v1/iot/app/device/personPassage/lift/call

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body Long 是 项目id
personId body Long 是 用户id
deviceId body String 是 设备id
floorNum body Integer 是 呼梯楼层

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

{
    "projectId": 21906,
    "personId": 257437,
    "deviceId": "0d5525e260b0c0ee",
    "floorNum": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
openSuccess data BOOLEAN 否 是否成功
errorMsg data STRING 否 失败原因 

{
    "code": 200,
    "data": {
        "openSuccess": false,
        "errorMsg": "系统内部错误"
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

3.5:日立电梯打开实时数据接口

描述

请求信息

URI：/v1/open/opt/elevator/realtime/upstream/trigger

方法：POST

请求参数

名称 位置 类型 必填 描述
opt param STRING 是 控制命令start开启,stop关闭
ids param ARRAY 是 需要查看实时数据电梯mac数组
appId param String 是 授权id（日立电梯填3000）

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

{
  "ids": ["17G048280"],
  "opt": "start",
  "appId": 3000
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象

返回结果示例

{
  "code": 200,
  "message": "success",
  "data": {
  }
}

3.6:日立电梯查询实时数据接口

描述

请求信息

URI：/v1/open/ioc/elevator/realtime/data/get

方法：POST

请求参数

名称 位置 类型 必填 描述
id param STRING 是 需要查看实时数据电梯mac

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

{
  "id": "17G048280"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 INTEGER 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
speed data STRING 是 当前速率 米/分
load data STRING 是 电梯负载 负载百分比
car_position data STRING 是 所在楼层
up_down_status data STRING 是 上行下行 0无1上行2下行
run_times data STRING 是 运行次数
run_time data STRING 是 运行时长 分钟
power_status data STRING 是 电源状态 0正常1异常
at_door data STRING 是 是否门区 1门区0非门区
inner_order data STRING 是 内招指令 1有指令0无指令
calling_order data STRING 是 外招指令 1有指令0无指令
safety_circuit_status data STRING 是 安全回路状态 1接通0断开
up_limit data STRING 是 上极限
down_limit data STRING 是 下极限
is_online data INTEGER 是 在线状态 1在线0离线
door_open data STRING 是 1开门，0无信号
door_close data STRING 是 1关门，0无信号

返回结果示例

{
    "code": 200,
    "data": {
        "speed": 1,
        "at_door": 1
        "inner_order": 1,
        "calling_order": 1,
        "door_open": 1,
        "door_close": 1,
        "create_time": "2019-12-05T07:24:53.569+0000",
        "run_time": null,
        "device_id": "1144508432",
        "power_status": null,
        "call_alarm": null,
        "down_limit": null,
        "run_times": null,
        "update_time": "2019-12-19T09:00:20.952+0000",
        "realtime_data_switch": "start",
        "car_position": null,
        "up_down_status": null,
        "call_status": null,
        "load": 1,
        "up_limit": null,
        "run_mode": null,
        "project_id": "21441118",
        "product_id": "160004bbd1b0232a160004bbd1b07401",
        "is_online": 1,
        "id": "17G048280",
        "safety_circuit_status": null,
        "have_person": null
    },
    "message": "success"
}

异常返回示例

{"code":401,"message":"Invalid Signature"}

错误码列表(13001-13999)

错误码 错误信息 描述
13001
公共错误码 -- 所有API公用的错误码，请参照《 公共错误码 》

results matching ""

    No results matching ""