1. 门禁接入

API列表

编号	API名称	路径	版本
1.1	门禁新增	/v1/iot/door/doorlock/insertDoorlock/{projectId}	1.0
1.2	门禁修改	/v1/iot/door/doorlock/updateDoorlock/{projectId}	1.0
1.3	门禁删除	/v1/iot/door/doorlock/deleteDoorlock/{projectId}	1.0
1.4	门禁查询	/v1/iot/door/doorlock/queryDoorlock	1.0
1.5	门禁换绑	/v1/iot/door/doorlock/changeDoorlock	1.0

API调用

1.1: 门禁新增

描述门禁接入新增

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/door/doorlock/insertDoorlock/{projectId}

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
userName	body	string	y	登录人
bizOrgCode	body	string	y	业务组织id
deviceId	body	string	n	设备id
deviceCode	body	string	y	设备编码
deviceName	body	string	y	设备名称
deviceModel	body	string	n	设备型号
mac	body	string	y	mac地址
sn	body	string	y	sn
productId	body	string	y	产品id
brand	body	string	n	品牌
installationPosition	body	string	n	安装位置
detailedLocation	body	string	n	详细地址
spatialLocation	body	string	y	空间位置
spatialId	body	string	y	空间位置id
type	body	int	y	门禁类型
typeName	body	string	y	门禁类型
doorName	body	string	y	门禁名称
doorOpenModeList	body	JSONARRAY	y	开门方式
openModeType	doorOpenModeList	string	y	开门类型
openModeName	doorOpenModeList	string	y	开门类型
doorResidentTypeList	body	JSONARRAY	y	人员类型
authResidentType	doorResidentTypeList	int	y	人员类型
authResidentName	doorResidentTypeList	string	y	人员类型
doorAuthScopeList	body	JSONARRAY	y	授权范围
authType	doorAuthScopeList	int	y	授权范围id
authName	doorAuthScopeList	string	y	授权范围名
buildingId	doorAuthScopeList	int	y	楼栋id
buildingName	doorAuthScopeList	string	y	楼栋名称
unitId	doorAuthScopeList	int	y	单元id
unitName	doorAuthScopeList	string	y	单元名称
parkingId	doorAuthScopeList	int	y	停车场id
parkingSubId	doorAuthScopeList	int	y	停车场子id
publicAreaId	doorAuthScopeList	int	y	公共场所id

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

{
    "params":[
        {
            "userName":"潘",
            "bizOrgCode": "600004bb3feb4c00",
            "deviceId":"619a22e35078421f",
            "deviceCode":"21291194_1000002_7_0_0",
            "deviceName":"实验室门禁",
            "deviceModel":"",
            "mac":"21291194_1000002_7_0_0",
            "sn":"BBBB",
            "productId":"160",
            "brand":"ABBBA",
            "installationPosition":"测试的",
            "detailedLocation":"测试的",
            "spatialLocation":"测试的",
            "spatialId": "空间id",
            "type":1,
            "typeName":"大门门禁",
            "doorName":"门禁名称",
            "doorOpenModeList":[
                {
                    "openModeType":"face",
                    "openModeName":"人脸"
                }
            ],
            "doorResidentTypeList":[
                {
                    "authResidentType":1,
                    "authResidentName":"业主"
                }
            ],
            "doorAuthScopeList":[
                {
                    "authType":1,
                    "authName":"一栋测试房",
                    "buildingId":50411629,
                    "buildingName":"1栋"
                }
            ]
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

1.2: 门禁修改

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/doorlock/updateDoorlock/{projectId}

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
userName	body	string	y	登录人
bizOrgCode	body	string	y	业务组织id
id	body	int	y	门禁id
deviceId	body	string	n	设备id
deviceCode	body	string	y	设备编码
deviceName	body	string	y	设备名称
deviceModel	body	string	n	设备型号
mac	body	string	y	mac地址
sn	body	string	y	sn
productId	body	string	y	产品id
brand	body	string	n	品牌
installationPosition	body	string	n	安装位置
detailedLocation	body	string	n	详细地址
spatialLocation	body	string	y	空间位置
spatialId	body	string	y	空间位置id
type	body	int	y	门禁类型
typeName	body	string	y	门禁类型
doorOpenModeList	body	JSONARRAY	y	开门方式
openModeType	doorOpenModeList	string	y	开门类型
openModeName	doorOpenModeList	string	y	开门类型
doorResidentTypeList	body	JSONARRAY	y	人员类型
authResidentType	doorResidentTypeList	int	y	人员类型
authResidentName	doorResidentTypeList	string	y	人员类型
doorAuthScopeList	body	JSONARRAY	y	授权范围
authType	doorAuthScopeList	int	y	授权范围id
authName	doorAuthScopeList	string	y	授权范围名
buildingId	doorAuthScopeList	int	y	楼栋id
buildingName	doorAuthScopeList	string	y	楼栋名称
unitId	doorAuthScopeList	int	y	单元id
unitName	doorAuthScopeList	string	y	单元名称
parkingId	doorAuthScopeList	int	y	停车场id
parkingSubId	doorAuthScopeList	int	y	停车场子id
publicAreaId	doorAuthScopeList	int	y	公共场所id

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

{
    "userName": "潘",
    "bizOrgCode": "600004bb3feb4c00",
    "id": 25,
    "deviceId": "619a22e35078421f",
    "deviceCode": "21291194_1000002_7_0_0",
    "deviceName": "实验室门禁",
    "deviceModel": "",
    "mac": "21291194_1000002_7_0_0",
    "sn": "BBBB",
    "productId": "160",
    "brand": "ABBBA",
    "installationPosition": "测试的",
    "detailedLocation": "测试的",
    "spatialLocation": "测试的",
    "spatialId": "空间id",
    "type": 1,
    "typeName": "大门门禁",
    "doorOpenModeList": [
        {
            "openModeType": "face",
            "openModeName": "人脸"
        }
    ],
    "doorResidentTypeList": [
        {
            "authResidentType": 1,
            "authResidentName": "业主"
        }
    ],
    "doorAuthScopeList": [
        {
            "authType": 1,
            "authName": "一栋测试房",
            "buildingId": 50411629,
            "buildingName": "1栋"
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

1.3: 门禁删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/doorlock/deleteDoorlock/{projectId}

方法：POST

名称	位置	类型	必填	描述

请求参数

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

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

{
   "params" : 
    [
        25
    ]
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

1.4: 门禁查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/doorlock/queryDoorlock

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
pageNo	body	int	y	页码
pageSize	body	int	y	页数量
projectId	body	int	y	项目id
buildingId	body	int	n	楼栋id
unitId	body	int	n	单元id
parkingId	body	int	n	车场id
parkingSubId	body	int	n	车场子id
areaId	body	int	n	空间id
deviceName	body	string	n	设备名
deviceId	body	string	n	设备id
sn	body	string	n	sn
brand	body	string	n	品牌
online	body	string	n	在线状态
type	body	string	n	门禁类型
residentTypeIds	body	string	n	用户类型
openModes	body	string	n	开门方式
isFromAuth	body	string	n	是否授权查询
personId	body	string	n	当授权查询必须传入

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

{
    "pageNo": 1,
    "pageSize": 10,
    "projectId": 21441121,
    "buildingId":"50411629",
    "online": "1",
    "type": "1",
    "residentTypeIds": "1,2,3",
    "openModes": "1,2,3",
    "isFromAuth": "true",
    "personId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": "26",
            "deviceId": "619a22e35078421f",
            "deviceName": "实验室门禁",
            "deviceCode": "21291194_1000002_7_0_0",
            "deviceModel": "",
            "mac": "21291194_1000002_7_0_0",
            "sn": "BBBB",
            "productId": "160",
            "brand": "ABBBA",
            "installationPosition": "测试的",
            "detailedLocation": "测试的",
            "spatialLocation": "测试的",
            "spatialId": "空间id",
            "type": "1",
            "typeName": "大门门禁",
            "online": "1",
            "scopeType": "1",
            "residentType": "业主",
            "createTime": "2020-09-17",
            "buildingId",
            "unitId",
            "parkingId",
            "parkingSubId",
            "publicAreaId",
            "residentId",
            "openModeId"
        }
    ]
}

1.5: 门禁换绑

描述

请求信息

HTTP协议：HTTP,HTTPS

uri： /v1/iot/door/doorlock/changeDoorlock

方法：POST

名称	位置	类型	必填	描述

请求参数

名称	位置	类型	必填	描述
doorId	body	string	y	门禁id
deviceId	body	int	y	设备id

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

{
    "doorId": "28",
    "deviceId": "0f8fdce30b9c018e"
}

返回信息

返回参数类型

JSON

返回参数

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

返回结果示例

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

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表单数据)

返回信息

返回参数类型

返回参数

返回结果示例

results matching ""

No results matching ""

描述门禁接入新增