1. 梯控接入

API列表

编号	API名称	路径	版本
1.1	梯控新增	/v1/iot/lift/ladderControl/submitLiftInstance	1.0
1.2	梯控修改	/v1/iot/lift/ladderControl/updateLiftInstance	1.0
1.3	梯控删除	/v1/iot/lift/ladderControl/removeLiftInstance	1.0
1.4	梯控查询	/v1/iot/lift/ladderControl/liftInstanceList	1.0
1.5	远程呼梯	/v1/iot/lift/ladderControl/remoteLiftCall	1.0
1.6	梯控换绑	/v1/iot/lift/ladderControl/changeBindLiftInstance	1.0

API调用

1.1: 梯控新增

描述梯控接入新增

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/lift/ladderControl/submitLiftInstance

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
list	body	JSONArray	y	设备列表
instanceName	list	string	y	实例名称
deviceId	list	string	y	设备id
deviceName	list	string	y	设备名称
productId	list	string	y	产品id
productName	list	string	y	产品名称
projectId	list	string	y	项目id
mac	list	string	y	mac地址
status	list	int	y	在线状态
areaId	list	string	y	项目id
areaName	list	string	y	项目名
buildId	list	string	y	建筑id
buildName	list	string	y	建筑名
callType	list	JSONArray	y	呼梯方式
userType	list	JSONArray	y	用户类型
floorNum	list	int	y	楼层数
floorDtos	list	JSONOArray	y	楼层列表
floorName	list.floorDtos	string	y	楼层名称
publicFloor	list.floorDtos	int	y	0 公共楼层 1 不公共
num	list.floorDtos	string	y	楼层号
unitIds	list	JSONArray	y	单元标识列表
unitNames	list	JSONArray	y	单元名称列表
address	list	string	y	设备地址
sn	list	string	y	sn
brand	list	string	n	品牌
spatialLocation	list	string	n	空间名
spatialId	list	string	n	空间id

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

{
    "list": [{
        "instanceName" :"测试实例名",
        "deviceId": 1416373841,
        "mac": "E-2008112001",
        "callType": ["FACE", "BLUETOOTH"],
        "userType": ["OWNER", "OWNER_MEMBER"],
        "productId": "160004bb430e232a160004bb430e3a01",
        "productName" : "测试模板名",
        "status": 0,
        "brand": "测试",
        "sn": "",
        "deviceName": "A区客梯",
        "floorNum": 2,
        "floorDtos": [{
            "floorName": "-1F",
            "num": -1,
            "publicFloor": 1
        }, {
            "floorName": "1F",
            "num": 1,
            "publicFloor": 1
        }],
        "projectId": "21441118",
        "buildId": "50410653",
        "buildName": "1栋",
        "unitIds": ["50410663"],
        "unitNames": ["1单元"],
        "prohibit": false,
        "spatialLocation" : "测试位置",
        "spatialId" : "aaa123"
    }]
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	是	响应码标识
success	顶层	boolean	是	是否成功
data	顶层	boolean	是	响应数据对象

返回结果示例

{
    "code": "0",
    "success": true,
    "msg": null,
    "data": true
}

1.2: 梯控修改、换绑

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/lift/ladderControl/updateLiftInstance

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
instanceId	body	string	y	梯控标识
instanceName	body	string	y	梯控名称
deviceName	body	string	y	设备名称
floorNum	body	int	y	楼层数
areaId	body	string	y	项目id
areaName	body	string	y	项目名
buildId	body	string	y	建筑id
buildName	body	string	y	建筑名
unitIds	body	JSONArray	y	单元标识列表
unitNames	body	JSONArray	y	单元名称列表
callType	body	JSONArray	y	呼梯方式
userType	body	JSONArray	y	用户类型
projectId	body	string	y	项目id
sn	body	string	y	sn
brand	body	string	n	品牌
deviceId	body	string	n	设备id
address	body	string	y	设备地址
prohibit	body	bool	y	是否禁用梯控
changeTies	body	bool	y	是否换绑梯控
newDeviceId	body	string	y	换绑设备标识
mac	body	string	y	设备mac
productId	body	string	y	产品标识
floorDtos	body	JSONArray	y	楼层列表
floorId	floorDtos	string	y	楼层id
instanceId	floorDtos	string	y	实例标识
floorName	floorDtos	string	y	楼层名称
num	floorDtos	int	y	楼层号
publicFloor	floorDtos	int	y	0 公共楼层 1 不公共
openFloor	floorDtos	int	y	0 开放 1 不开放针对（业主和员工）

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

{
    "instanceId": "5e5f8d51b0be5aeb693e335659",
    "instanceName": "测试实例名",
    "deviceId": "1416372921",
    "deviceName": "日立电梯17g048281",
    "mac": "17G048281",
    "floorNum": 1,
    "areaName": null,
    "areaId": null,
    "buildName": "A楼栋",
    "buildId": "59d01492c5ec5607e87ba7db43054732",
    "unitNames": [],
    "unitIds": [],
    "productId": "160004bbd1b0232a160004bbd1b07401",
    "callType": ["FACE"],
    "userType": ["VISITOR"],
    "sn": null,
    "brand": "日立",
    "prohibit": false,
    "floorDtos": [{
        "instanceId": "5e5f8d51b0be5aeb693e335659",
        "floorName": "-1F",
        "num": -1,
        "public_floor": 1,
        "open_floor": null,
        "floorId": "5e5f8d51b0be5aeb693e33565a"
    }],
    "address": "",
    "newDeviceId": "1144508147",
    "changeTies": true
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	顶层	STRING	y	响应码标识
success	顶层	boolean	y	是否成功
data	顶层	boolean	y	响应数据对象

返回结果示例

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

1.3: 梯控删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/lift/ladderControl/removeLiftInstance

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
ids	body	JSONARRAY	y	门禁id

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

{
    "ids": ["5c5f8a5b19be5aeb0b6fca9bd2"]
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

1.4: 梯控查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/lift/ladderControl/liftInstanceList

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数量
deviceId	body	string	n	设备id
status	body	JSONArray	n	在线状态
deviceName	body	string	n	设备名
sn	body	string	n	设备SN
brand	body	string	n	品牌
mac	body	string	n	mac地址
areaId	body	string	n	空间id
buildId	body	string	n	楼栋id
unitIds	body	JSONArray	n	单元id
callType	body	JSONArray	n	呼梯方式
userType	body	JSONArray	n	用户类型
configure	body	JSONArray	n	是否完成配置
projectId	body	int	y	项目id
excludeUserId	body	string	n	需要该userId拥有的梯控

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

{
    "pageNo": 1,
    "pageSize": 10,
    "projectId": 21441121,
    "buildId":"50411629"
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {
        "total" : 321
        "result":[
            {
                "instanceId": "26",
                "instanceName": "测试实例名",
                "deviceId": "619a22e35078421f",
                "deviceName": "实验室门禁",
                "mac": "21291194_1000002_7_0_0",
                "floorNum": 23,
                "areaName": "23",
                "areaId": "23",
                "buildName": "23",
                "buildId": "23",
                "unitNames": ["23"],
                "unitIds": ["23"],
                "updateTime": "2020-11-03 15:01:42",
                "status": 1,
                "productId": "160",
                "callType": ["FACE"],
                "userType": ["OWNER"],
                "authorizationCompleted": true,
                "accessCompleted": true,
                "sn": "BBBB",
                "brand": "ABBBA",
                "prohibit": false,
                "spatialLocation": "虚拟位置",
                "spatialId": "aaa123"
            }
        ]
    }
}

1.5: 远程呼梯

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/lift/ladderControl/remoteLiftCall

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
deviceId	body	string	y	设备id
projectId	body	string	y	项目id
floorNum	body	string	y	楼层数
userId	body	string	y	用户Id

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

{
    "projectId": "21441121",
    "deviceId":"50411629",
    "floorNum":3,
    "userId":"50411629"
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {

    }
}

1.6: 梯控换绑

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/lift/ladderControl/changeBindLiftInstance

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
liftInstanceId	body	string	y	梯控实例Id
projectId	body	string	y	项目id
newDevice	body	JSONObject	y	换绑到的设备
deviceId	newDevice	string	y	设备Id
productId	newDevice	string	y	产品Id
projectId	newDevice	string	y	项目Id
deviceName	newDevice	string	y	设备名
mac	newDevice	string	y	设备mac
address	newDevice	string	y	设备地址
brand	newDevice	string	y	品牌
sn	newDevice	string	y	sn
status	newDevice	string	n	在离线状态

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

{
    "liftInstanceId": "21441121",
    "projectId":"50411629",
    "newDevice":{
        "deviceId": "device1111",
        "productId": "product1111",
        "projectId": "project1111",
        "deviceName": "测试设备名",
        "mac": "mac-112",
        "address": "aaaa1111",
        "brand": "测试品牌",
        "sn": "testSn",
        "status": "1"
    }
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
    "code": "200",
    "success": true,
    "data": {

    }
}

1. 梯控接入

API列表

API调用

1.1: 梯控新增

描述 梯控接入新增

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

1.2: 梯控修改、换绑

描述

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

1.3: 梯控删除

描述

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

1.4: 梯控查询

描述

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

1.5: 远程呼梯

描述

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

1.6: 梯控换绑

描述

请求信息

header

请求参数

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

返回信息

返回参数类型

返回参数

返回结果示例

results matching ""

No results matching ""

描述梯控接入新增