添加门组

接口说明

添加门组

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/doorGroup

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
namestring64名称,仅允许数字、字母、下划线、中文
orgCodestring90门组所属组织编码,参考组织分页查询 接口或设备树查询接口获取
memostring255备注,不能包含%或_
doorGroupDetailarray3000门组详情列表,列表不支持重复,建议用Set集合处理
+channelCodestring64门禁通道编码,可通过基础资源-设备管理,获取门禁通道编码

请求示例

{
    "name": "门组1",
    "memo": "门组1备注",
    "doorGroupDetail": [
        {
            "channelCode": "1000001$7$0$0"
        },
        {
            "channelCode": "1000001$7$0$1"
        }
    ],
    "orgCode": "001"
}

返回参数

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
datalong门组ID
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "data":23,
    "errMsg": "success",
    "success": true
}
修改门组

接口说明

修改门组

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/doorGroup/update

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
idlong-门组ID
namestring64名称,仅允许数字、字母、下划线、中文
orgCodestring90门组所属组织编码,参考组织分页查询 接口或设备树查询接口获取
memostring255备注
addDoorGroupRelDoorListarray3000新增通道列表
+ channelCodestring64通道编码,可通过基础资源-设备管理,获取门禁通道编码
deleteDoorGroupRelDoorListarray3000删除通道列表
+ channelCodestring64通道编码,可通过基础资源-设备管理,获取门禁通道编码

请求示例

{
    "id": 2,
    "name": "门组2",
    "orgCode": "001",
    "memo": "门组2",
    "addDoorGroupRelDoorList": [
        {
            "channelCode": "1000003$7$0$0"
        },
        {
            "channelCode": "1000003$7$0$1"
        }
    ],
    "deleteDoorGroupRelDoorList": [
        {
            "channelCode": "1000004$7$0$0"
        },
        {
            "channelCode": "1000004$7$0$1"
        }
    ]
}

返回参数说明

参数类型描述
codestring错误码
datalong门组ID
errMsgstring错误信息
successboolean是否成功

返回示例

{
    "code": "0",
    "data": "2"
    "errMsg": "success",
    "success": true
}
删除门组

接口说明

删除门组

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/doorGroup/delete/batch

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
doorGroupIdsarray1000门组ID数组,参考门组列表 接口获取的id字段

请求示例

{
    "doorGroupIds": [2]
}

返回参数

参数类型描述
codestring错误码
errMsgstring错误信息
successboolean是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
门组详情

接口说明

单个查询门组

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/doorGroup/{id}

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
idstring-门组ID,若包含$false, 则表示不查询智能锁通道、考勤机和围墙机

请求示例

/evo-apigw/evo-accesscontrol/{version}/card/accessControl/doorGroup/2

返回参数

参数类型描述
codestring错误码
successboolean是否成功
errMsgstring错误信息
dataobject详情
+idlong门组ID
+namestring门组名称
+orgCodestring门组所属组织编码
+orgNamestring组织名称
+hasChildChannelboolean是否有通道
+memostring备注
+doorGroupDetailarray通道详情
++idlong关联表ID
++channelCodestring通道编码
++channelNamestring通道名称
++deviceCodestring设备编码
++deviceNamestring设备名称
++deviceStatusstring设备在离线状态,ON在线,OFF离线
++groupIdlong门组ID
++onlinestring通道是否在线,1在线,0离线
++orgNamestring通道所属组织名称

返回示例

{
    "code": "0",
    "data": {
        "doorGroupDetail": [
            {
                "channelCode": "1000001$7$0$0",
                "channelName": "10.35.122.187_门禁通道_1",
                "deviceCode": "1000001",
                "deviceName": "10.35.122.187",
                "deviceStatus": "ON",
                "groupId": 2,
                "id": 2,
                "online": "1",
                "orgName": "根节点"
            },
            {
                "channelCode": "1000003$7$0$0",
                "channelName": "1.1.1.110_门禁通道_1",
                "deviceCode": "1000003",
                "deviceName": "1.1.1.110",
                "deviceStatus": "OFF",
                "groupId": 2,
                "id": 3,
                "online": "0",
                "orgName": "根节点"
            }
        ],
        "hasChildChannel": true,
        "id": 2,
        "memo": "门组2",
        "name": "门组2",
        "orgCode": "001",
        "orgName": "根节点"
    },
    "errMsg": "success",
    "success": true
}
门组列表

接口说明

分页查询门组

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/doorGroup/bycondition/combined

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
pageNumint-页码,正整数, 默认1
pageSizeint-每页记录数,正整数
singleConditionstring64门组名称,支持模糊搜索

请求示例

{
  "singleCondition": "门组1",
  "pageNum": 1,
  "pageSize": 20
}

返回参数

参数类型描述长度
successboolean是否成功
errMsgstring错误信息
dataobject查询结果
+currentPagelong当前页码
+pageSizeint每页记录数
+totalPageint总页数
+totalRowsint记录总条数
+enableCloudDBboolean废弃属性
+pageDataarray分页数据
++idlongID
++namestring名称
++orgCodestring组织编码
++orgNamestring组织名称
++hasChildChannelboolean是否有通道
++memostring备注

返回示例

{
    "code": "0",
    "data": {
        "pageData": [
            {
                "id": 1,
                "name": "门组1",
                "orgCode": "001",
                "orgName": "根节点",
                "hasChildChannel": true,
                "memo": "门组1备注"
            },
            {
                "id": 2,
                "name": "门组2",
                "orgCode": "001",
                "orgName": "根节点",
                "hasChildChannel": true,
                "memo": "门组2备注"
            }
        ],
        "currentPage": 1,
        "pageSize": 20,
        "totalPage": 1,
        "totalRows": 1,
        "enableCloudDB": false
    },
    "errMsg": "success",
    "success": true
}
添加常开常闭计划

接口说明

添加常开常闭计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/channel/openNormallySetting/add

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
channelCodestring64通道编码,可通过基础资源-设备管理,获取门禁通道编码
onlineStatusstring-通道在离线状态,只能配置在线的门禁通道,固定传ON
openDoorsPlanIdint-常开计划索引(时间计划index),调时间计划列表接口获取的index字段;
常开计划和常闭计划,不能同时为空,时间段不能重复
closeDoorsPlanIdint-常闭计划索引(时间计划index),调时间计划列表接口获取的index字段;
常开计划和常闭计划,不能同时为空,时间段不能重复

请求示例

{
    "channelCode": "1001687$7$0$0",
    "onlineStatus": "ON",
    "openDoorsPlanId": 3,
    "closeDoorsPlanId": 4
}

返回参数说明

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
修改常开常闭计划

接口说明

修改常开常闭计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/channel/openNormallySetting/update

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
channelCodestring64通道编码,可通过基础资源-设备管理,获取门禁通道编码
onlineStatusstring-通道在离线状态,只能配置在线的门禁通道,固定传ON
openDoorsPlanIdint-常开计划索引(时间计划index),调时间计划列表接口获取的index字段;
常开计划和常闭计划,不能同时为空,时间段不能重复
closeDoorsPlanIdint-常闭计划索引(时间计划index),调时间计划列表接口获取的index字段;
常开计划和常闭计划,不能同时为空,时间段不能重复

请求示例

{
    "channelCode": "1001687$7$0$0",
    "onlineStatus": "ON",
	"openDoorsPlanId": 3,
	"closeDoorsPlanId": 4
}

返回参数

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
删除常开常闭计划

接口说明

删除常开常闭计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/channel/openNormallySetting/delete

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
channelCodestring-通道编码,多个使用逗号分隔,(可通过设备管理接口,获取unitType为7的channels)

请求示例

{
    "channelCode": "1001687$7$0$0"
}

返回参数

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
常开常闭计划列表

接口说明

分页查询常开常闭计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/channel/openNormallySettingRest/bycondition/combined

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
pageNumint-页码,正整数,默认1
pageSizeint-每页记录数,正整数
singleConditionstring64查询条件,支持模糊搜索通道名称

请求示例

{
    "pageNum": 1,
    "pageSize": 20,
    "singleCondition": "通道1"
}

返回参数

参数名类型说明
errMsgstring错误信息
successboolean请求是否成功
dataobject数据对象
+currentPageint当前页数
+pageSizeint每页记录数
+pageDataobject页数据
++channelCodestring通道编码
++channelNamestring通道名称
++closeDoorsPlanIdint常闭计划 ID
++closeDoorsPlanNamestring常闭计划名称
++deviceNamestring设备名称
++escFlagboolean是否为高峰计划配置
++flagboolean无实际意义
++idlong常开常闭计划id
++onlineStatusstring通道在离线状态: "ON" - 在线,"OFF" - 离线
+totalPageint总页数
+totalRowsint总记录数
codestring错误码

返回示例

{
	"code": "0",
	"data": {
		"currentPage": 1,
		"pageData": {
			"channelCode": "1000094$7$0$0",
			"channelName": "149_通道1",
			"closeDoorsPlanId": 4,
			"closeDoorsPlanName": "下午",
			"deviceName": "149",
			"escFlag": false,
			"flag": false,
			"id": 1,
			"onlineStatus": "ON"
		},
		"pageSize": 20,
		"totalPage": 1,
		"totalRows": 1
	},
	"errMsg": "success",
	"success": true
}
添加时间计划

接口说明

添加时间计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.1.2 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
detailstring1024时间计划细节,monday-sunday代表周一到周日,每天可以配置四个时间段,前后时间段不能重叠
memostring512描述
namestring64时间计划名称,仅允许汉字字母数字 -_.@
typeint-计划类型:1 - 普通时段。目前只支持普通时段

请求示例

{
    "detail": "{'monday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'tuesday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'wednesday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'thursday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'friday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'saturday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'sunday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00']}",
    "memo": "测试1",
	"name": "test1",
	"type": 1
}

返回参数说明

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
datalong时间计划ID
errMsgString错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true,
    "data": 2
}
修改时间计划

接口说明

修改时间计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.1.2 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum/update

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
idlong-时间计划ID
detailstring1024时间计划细节,monday-sunday代表周一到周日,每天可以配置四个时间段,前后时间段不能重叠
memostring512描述
namestring64时间计划名称,仅允许汉字字母数字 -_.@
typeint-计划类型:1 - 普通时段。目前只支持普通时段

请求示例

{
    "id": 2,
    "detail": "{'monday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'tuesday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'wednesday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'thursday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'friday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'saturday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00'],'sunday':['00:00:00-23:59:59','00:00:00-00:00:00','00:00:00-00:00:00','00:00:00-00:00:00']}",
    "memo": "测试1_update",
    "name": "test1_update",
    "type": 1
}

返回参数

参数名类型说明
codestring错误码
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
批量删除时间计划

接口说明

删除时间计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum/delete

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
idsarray1000时间计划ID列表

请求示例

{
    "ids": [3, 4]
}

返回参数说明

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgstring错误信息
successboolean请求是否成功

返回示例

{
    "code": "0",
    "errMsg": "success",
    "success": true
}
时间计划详情

接口说明

根据索引查询时间计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum/getByIndex/{index}

请求Method

GET

数据提交格式

application/json

请求参数

参数名必选类型长度说明
indexint-时间计划索引

请求示例

/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum/getByIndex/23

返回参数

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgstring错误信息
successboolean请求是否成功
dataobject数据对象
+detailstring计划详情
+idlong计划ID
+indexint计划索引,在服务中作为唯一标识
+memostring描述
+namestring计划名称
+syncStatusint计划同步到服务的状态:0 - 未同步 1 - 已同步
+typeint计划类型

返回示例

{
    "code": "0",
    "data": {
                "detail": "{\"monday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"tuesday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"wednesday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"thursday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"friday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"saturday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"sunday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"]}",
                "id": 2,
                "index": 23,
                "memo": "测试1_update",
                "name": "test1_update",
                "syncStatus": 0,
                "type": 1
    },
    "errMsg": "success",
    "success": true
}
时间计划列表

接口说明

分页查询时间计划

前置条件

请求头设置Authorization字段

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6 及以上版本

门禁管理子系统 V1.0.0 及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-accesscontrol/1.0.0/card/accessControl/timeQuantum/1/page

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型长度说明
singleConditionstring64按时间计划名称查询,支持模糊查询
pageNumint-请求页码,正整数,默认1
pageSizeint-每页记录数,正整数

请求示例

{
    "singleCondition": "test1",
    "pageNum": 1,
    "pageSize" : 20
}

返回参数

参数名类型说明
codestring错误码:0代表成功,非0具体错误码
errMsgString错误信息
successboolean请求是否成功
dataobject数据对象
+currentPageint当前页数
+pageSizeint每页记录数
+totalPageint总页数
+totalRowsint总记录数
+pageDataarray页数据
++detailstring计划详情
++idlong计划ID
++indexint计划索引,在服务中作为唯一标识
++memostring描述
++namestring计划名称
++syncStatusint计划同步到服务的状态: 0 - 未同步 1 - 已同步
++typeint计划类型

返回示例

{
    "code": "0",
    "data": {
        "currentPage": 1,
        "pageData": [
            {
                "detail": "{\"monday\":[\"00:00:00-23:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"tuesday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"wednesday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"thursday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"friday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"saturday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"],\"sunday\":[\"00:00:00-23:59:59\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\",\"00:00:00-00:00:00\"]}",
                "id": 2,
                "index": 2,
                "memo": "测试1_update",
                "name": "test1_update",
                "syncStatus": 0,
                "type": 1
            }
        ],
        "pageSize": 20,
        "totalPage": 1,
        "totalRows": 1
    },
    "errMsg": "success",
    "success": true
}