出入管理平台对外API接口

开始开发

事件编号	事件名称	备注
257	常闭时段识别	记录流水判断权限信息(可做考勤用)
258	未找到账户	没下发账户信息
259	账户过期或未生效	判断账户有效期
260	账户进黑名单	暂时终端只存放白名单
261	账户密码认证失败	卡+密码认证时段使用
262	潜回识别	正常权限判断后，开门之前判断是否反潜回
263	门互锁	一个控制器的几个门锁如果标识为互锁标记。那这几个门锁同时只能有一个门开门，需要配合门磁一起使用判断
264	无效时段	有权限，但当前时间是在权限有效时段外
265	副卡无权限	不启用副卡的时候，刷副卡
266	无权限	找不到权限信息
267	过期二维码	过期
268	无效二维码	无效
269	正常开门(短效)	正常开门
270	正常开门(长效)	正常开门
271	出门按钮开门	-
272	键盘密码开门	控制器的开门密码开门
273	键盘开门失败	错误密码输入
274	远程开门
275	消防联动开门	消防区域内平台软联动下发，终端执行开门
276	无效卡	-
277	NFC复制卡开门	-
278	正常通过	闸机事件
279	无卡通过	闸机事件
280	反冲事件	闸机事件
281	尾随事件	闸机事件
282	超时未通过	闸机事件
283	通道内滞留	闸机事件
284	翻越	闸机事件
285	机械钥匙开门
286	强行闯入
287	开门失败
288	正常开门
289	梯控识别	识别成功后把允许的楼层列表一同上传

公共分类

在线鉴权

基本信息

Version： ACS2.0.24..0812

Path： /api/v1/authenticateUser

Method： POST

接口描述：

24.0812冲刺新增接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
dotNum	string	必须		出入点编号
userNum	string	必须		用户ID
nowDate	string	非必须		时间 yyyy-MM-dd HH:mm:ss 不传就默认获取系统当前时间
verifyFlag	number	非必须		是否校验参数，1 校验，0不校验 默认 0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object	必须
├─ authStatus	number	必须		鉴权状态 1 通过 0不通过
├─ eventNum	number	非必须		事件编码

出入事件查询

分页获取出入事件记录

基本信息

Version： ACS2.0.24..0624

Path： /api/v1/record/list/webapi

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
userNumber	string	非必须		用户人员编号，精准匹配
userId	string	非必须		用户唯一id
recNums	string []	非必须		出入记录编号集合	item 类型: string
├─		非必须
classIds	string []	非必须		用户分类编号集合	item 类型: string
├─		非必须
depIds	string []	非必须		组织机构编号集合	item 类型: string
├─		非必须
current	integer	非必须		当前页码，默认1
pageSize	integer	非必须		每页大小，默认10，最大1000
startTime	string	必须		开始时间，格式：yyyy-MM-dd HH:mm:ss
endTime	string	必须		结束时间，格式：yyyy-MM-dd HH:mm:ss
dotNums	number []	非必须		门禁点编号集合	item 类型: number
├─		非必须
deviceNums	number []	非必须		设备编号集合(设备中台号)	item 类型: number
├─		非必须
mediumValue	number	非必须		识别方式：0-卡；1-脸；4-码；3-指纹；5-虹膜；6-指静脉
inOutType	number	非必须		进出方向：0-无；1-进；2-出；
areaNums	number []	非必须		区域编号集合	item 类型: number
├─		非必须
orderType	integer	非必须		排序方式：0-升序；1-降序，默认0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object	必须		查询结果数据
├─ records	object []	必须		出入记录集合，排序字段：发生时间ocurrTime	item 类型: object
├─ recNum	number	必须		记录编号
├─ dotNum	number	必须		出入点编号
├─ deviceNum	number	必须		设备编号
├─ eventNum	integer	必须		事件类型序号
├─ userNum	string	必须		用户ID
├─ cardId	string	必须		卡号
├─ mediumValue	integer	必须		识别方式：0-卡；1-脸；4-码；3-指纹；5-虹膜；6-指静脉
├─ doorId	integer	必须		门序号
├─ ocurrTime	string	必须		发生时间，格式：yyyy-MM-dd HH:mm:ss
├─ inOutType	integer	必须		进出方向：0-无；1-进；2-出；
├─ userName	string	必须		用户姓名
├─ userNumber	string	必须		个人编号
├─ accountNumber	string	必须		账号
├─ classIds	string	必须		用户分类id，多个逗号分割
├─ classNames	string	必须		用户分类名称，多个逗号分割
├─ depIds	string	必须		组织机构id，多个逗号分割
├─ depNames	string	必须		组织机构名称，多个逗号分割
├─ areaNum	number	必须		区域编号
├─ areaName	string	必须		区域名称
├─ dotName	string	必须		门禁点名称
├─ eventName	string	必须		事件名称
├─ inOutName	string	必须		识别方式名称：无/进/出
├─ mediumName	string	必须		识别方式名称：卡/码/脸
├─ photoAddress	string	必须		抓拍地址，如果不存在为空字符
├─ fixId	number	必须		版本号
├─ deviceName	string	必须		设备名称
├─ typeName	string	必须		设备型号
├─ modelName	string	必须		设备类型
├─ fullAreaName	string	必须		区域全路径
├─ thirdAreaNum	string	必须		第三方区域编号

分页获取用户出入事件记录

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/access/record/page/user

Method： POST

接口描述：

事件配置

事件序号	事件名称	备注
257	常闭时段识别	记录流水判断权限信息(可做考勤用)
258	未找到账户	没下发账户信息
259	账户过期或未生效	判断账户有效期
260	账户进黑名单	暂时终端只存放白名单
261	账户密码认证失败	卡+密码认证时段使用
262	潜回识别	正常权限判断后，开门之前判断是否反潜回
263	门互锁	一个控制器的几个门锁如果标识为互锁标记。那这几个门锁同时只能有一个门开门，需要配合门磁一起使用判断
264	无效时段	有权限，但当前时间是在权限有效时段外
265	副卡无权限	不启用副卡的时候，刷副卡
266	无权限	找不到权限信息
267	过期二维码	过期
268	无效二维码	无效
269	正常开门(短效)	正常开门
270	正常开门(长效)	正常开门
271	出门按钮开门	-
272	键盘密码开门	控制器的开门密码开门
273	键盘开门失败	错误密码输入
274	远程开门	-
275	消防联动开门	消防区域内平台软联动下发，终端执行开门
276	无效卡	-
277	NFC复制卡开门	-

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	必须		租户编号
userNumber	string	必须		用户人员编号，精准匹配
current	integer	非必须		当前页码，默认1
pageSize	integer	非必须		每页大小，默认10，最大1000
startTime	string	非必须		开始时间，格式：yyyyMMddHHmmss
endTime	string	非必须		结束时间，格式：yyyyMMddHHmmss
dotNums	number []	非必须		门禁点编号集合	item 类型: number
├─		非必须
deviceNums	number []	非必须		设备编号集合	item 类型: number
├─		非必须
eventNums	integer []	非必须		事件序号集合，属性值参考附录：事件配置	item 类型: integer
├─		非必须
mediumTypes	integer []	非必须		识别方式：0-卡；1-脸；2-码；	item 类型: integer
├─		非必须
inOutTypes	integer []	非必须		进出方向：0-无；1-进；2-出；	item 类型: integer
├─		非必须
areaNums	number []	非必须		区域编号集合	item 类型: number
├─		非必须
order	integer	非必须		排序方式：0-升序；1-降序，默认0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object	必须		查询结果数据
├─ records	object []	必须		出入记录集合，排序字段：发生时间ocurrTime	item 类型: object
├─ recNum	number	必须		记录编号
├─ dotNum	number	必须		出入点编号
├─ deviceNum	number	必须		设备编号
├─ eventNum	integer	必须		事件类型序号
├─ userNum	string	必须		用户ID
├─ cardId	string	必须		卡号
├─ mediumType	integer	必须		识别方式：0-卡；1-脸；2-码；
├─ deviceSid	integer	必须		设备流水号
├─ doorId	integer	必须		门序号
├─ ocurrTime	string	必须		发生时间，格式：yyyy-MM-dd HH:mm:ss
├─ inOutType	integer	必须		进出方向：0-无；1-进；2-出；
├─ temperature	string	必须		通过时的体温
├─ userName	string	必须		用户姓名
├─ userNumber	string	必须		个人编号
├─ accountNumber	string	必须		账号
├─ classIds	string	必须		用户分类id，多个逗号分割
├─ classNames	string	必须		用户分类名称，多个逗号分割
├─ depIds	string	必须		组织机构id，多个逗号分割
├─ depNames	string	必须		组织机构名称，多个逗号分割
├─ areaNum	number	必须		区域编号
├─ areaName	string	必须		区域名称
├─ dotName	string	必须		门禁点名称
├─ eventName	string	必须		事件名称
├─ inOutName	string	必须		识别方式名称：无/进/出
├─ mediumName	string	必须		识别方式名称：卡/码/脸
├─ pvAddress	string	必须		抓拍地址，如果不存在为空字符
├─ fixId	number	必须		版本号
├─ thirdAreaNum	string	必须		第三方区域编号
├─ total	number	必须		符合当前查询条件的总记录条数

增量出入事件记录获取

基本信息

Version： ACS2.0.23.1130,ACS2.0.24.0923

Path： /api/v1/access/record/incremental

Method： POST

接口描述：

出参增加第三方区域编号

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
gtFixId	number	必须		出入事件记录最小版本号，获取的出入事件记录fixId > gtFixId
limit	integer	非必须		数量, 默认1000，上限1000

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须		事件记录集合	item 类型: object
├─ recNum	number	必须		事件记录唯一编号
├─ dotNum	number	必须		出入点编号
├─ deviceNum	number	必须		设备编号
├─ eventNum	integer	必须		事件类型序号，说明参考相关文档
├─ userNum	number	必须		用户ID
├─ cardId	string	必须		卡号
├─ mediumType	integer	必须		识别方式：0-卡；1-脸；2-码；
├─ deviceSid	integer	必须		设备流水号
├─ doorId	integer	必须		门序号
├─ ocurrTime	string	必须		发生时间，格式：yyyy-MM-dd HH:mm:ss
├─ inOutType	integer	必须		进出方向：0-无；1-进；2-出；
├─ temperature	string	必须		通过时的体温
├─ userName	string,null	必须		用户姓名
├─ userNumber	string,null	必须		个人编号
├─ accountNumber	string,null	必须		账号
├─ classIds	string,null	必须		用户分类id，多个逗号分割
├─ classNames	string,null	必须		用户分类名称，多个逗号分割
├─ depIds	string,null	必须		组织机构id，多个逗号分割
├─ depNames	string,null	必须		组织机构名称，多个逗号分割
├─ areaNum	number	必须		区域编号
├─ areaName	string,null	必须		区域名称
├─ dotName	string,null	必须		门禁点名称
├─ eventName	string	必须		事件名称
├─ inOutName	string	必须		识别方式名称：无/进/出
├─ mediumName	string	必须		识别方式名称：卡/码/脸
├─ pvAddress	string	必须		抓拍地址，如果不存在为空字符
├─ fixId	number	必须		版本号
├─ thirdAreaNum	string	必须		第三方区域编号

新增出入事件

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/record/add

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
serialNum	string	必须		设备序列号
ocurrTime	string	必须		事件发生时间
eventNum	string	必须		事件类型(yyyy-MM-dd HH:mm:ss)
queryType	string	必须		查询用户使用的类型（0-人员唯一id，1-人员编号）
queryNum	string	必须		查询用户对应的编号
thirdRecNum	string	非必须		第三方事件记录号
cardId	string	非必须		物理卡号
deviceName	string	非必须		设备名称
deviceTypeName	string	非必须		设备类型名称
deviceModelName	string	非必须		设备型号名称
doorId	string	非必须		门序号
inOutType	string	必须		进门方式(0-未知，1-进，2-出)
mediumValue	string	必须		识别方式（0-卡；1-脸；4-码；3-指纹；5-虹膜；6-指静脉）
photoAddress	string	非必须		抓拍照片url
videoAddress	string	非必须		联动视频url
dotNum	string	非必须		出入点编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息

新增或修改出入事件关联照片、抓拍视频

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/record/updRecordMedium

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用id

Body

名称	类型	是否必须	默认值	备注	其他信息
recNum	string	必须		主事件记录号主键
photoAddress	string	非必须		抓拍照地址，不传时以下两个照片参数也可以不传
photoType	number	必须		照片地址类型，默认0伶云文件服务器地址，1其他地址
photoMd5	string	必须		照片地址为0伶云时，必传参数
videoAddress	string	非必须		联动视频地址，不传时以下两个参数也可以不传
videoType	number	必须		视频地址类型，默认0伶云文件服务器地址，1其他地址
videoMd5	string	必须		视频地址为0伶云时，必传参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述

获取出入事件记录最大版本号

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/access/record/fixId/max

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	number	必须		最大fixId

短效权限

修改用户短效权限

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/short/strategy/update/user

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	必须		租户编号
userNumber	string	必须		人员编号
recNum	number	必须		需要修改的短效权限记录编号
startDate	string	必须		开始日期，格式：yyyyMMddHHmmss
endDate	string	必须		结束日期，格式：yyyyMMddHHmmss

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间

删除用户短效权限

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/short/strategy/delete/user

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	必须		租户编号
userNumber	string	必须		人员编号
recNums	number []	非必须		短效权限记录编号集合，上限1000	item 类型: number
├─		非必须
dotNums	number []	非必须		出入点编号集合，上限100	item 类型: number
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间

增量短效权限下发记录获取

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/short/strategy/dd/incremental

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
limit	integer	非必须		数量, 默认10000，最大100000
gtFixId	number	非必须		开始版本号，获取版本号>gtFixId的数据
leFixId	number	非必须		结束版本号,获取版本号<=leFixId的数据
recFlag	integer	非必须		有效数据过滤标记：0-无效 1-有效 其它值-不过滤
dotNums	number []	非必须		出入点编号集合	item 类型: number
├─		非必须
userNums	number []	非必须		用户编号集合	item 类型: number
├─		非必须
startTime	string	非必须		开始时间，获取开始时间>=startTime的数据，格式：yyyyMMddHHmmss
endTime	string	非必须		结束时间，获取开始时间<=endTime的数据，格式：yyyyMMddHHmmss

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须		数据集合	item 类型: object
├─ recNum	number	必须		记录唯一编号
├─ userNum	number	必须		用户ID
├─ startTime	string	必须		开始时间，格式：yyyy-MM-dd HH:mm:ss
├─ endTime	string	必须		结束时间，，格式：yyyy-MM-dd HH:mm:ss
├─ recFlag	number	必须		是否有效 0-否 1-是
├─ fixId	number	必须		版本号

新增用户短效权限

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/short/strategy/add/user

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	必须		租户编号
userNumber	string	非必须		人员编号，非必传，与人员编号集合不能都为空
userNumbers	string []	非必须		人员编号集合，非必传，与人员编号不能都为空	item 类型: string
├─		非必须
dotNums	string []	必须		出入点编号集合，上限100	item 类型: string
├─		非必须
startDate	string	必须		开始使用日期，格式：yyyyMMddHHmmss
endDate	string	必须		结束使用日期，格式：yyyyMMddHHmmss

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须		新增成功后，返回对应短效权限数据集	item 类型: object
├─ recNum	number	必须		短效权限唯一记录编号，一个用户一个出入点对应一条数据
├─ userNumber	string	必须		人员编号
├─ dotNum	number	必须		出入点编号
├─ startDate	string	必须		开始使用日期,格式：yyyyMMddHHmmss
├─ endDate	string	必须		结束使用日期,格式：yyyyMMddHHmmss

查询用户短效权限

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/short/strategy/query/user

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	必须		租户编号
userNumber	string	必须		人员编号
dotNums	string []	非必须		出入点编号集合，上限100	item 类型: string
├─		非必须
startDate	string	非必须		开始日期，格式：yyyyMMddHHmmss，查询权限开始时间大于等于该时间数据
endDate	string	非必须		结束日期，格式：yyyyMMddHHmmss，查询权限结束时间小于等于该时间数据

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须		查询结果数据集	item 类型: object
├─ recNum	number	必须		短效权限唯一记录编号
├─ userNumber	string	必须		人员编号
├─ dotNum	number	必须		出入点编号
├─ startDate	string	必须		开始使用日期,格式：yyyyMMddHHmmss
├─ endDate	string	必须		结束使用日期,格式：yyyyMMddHHmmss

获取短效权限下发最大版本号

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/short/strategy/dd/fixId/max

Method： POST

接口描述：

24.0719冲刺
1、新增接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
recFlag	integer	非必须		有效数据过滤标记：0-无效 1-有效 其它值-不过滤
dotNums	number []	非必须		出入点编号集合	item 类型: number
├─		非必须
userNums	number []	非必须		用户编号集合	item 类型: number
├─		非必须
startTime	string	非必须		开始时间，获取开始时间>=startTime的数据，格式：yyyyMMddHHmmss
endTime	string	非必须		结束时间，获取开始时间<=endTime的数据，格式：yyyyMMddHHmmss

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	number	必须		最大fixId

长效权限

设置用户长效权限

基本信息

Version： ACS2.0.23.1130,ACS2.0.24.0923

Path： /api/v1/long/strategy/user

Method： POST

接口描述：

24.0923冲刺：
1）增加响应参数data

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	非必须		租户编号，不传则使用出入系统配置的默认租户编号
userNumbers	string []	必须		人员编号集合，上限1000	item 类型: string
├─		非必须
dotNums	number []	必须		出入点编号集合，上限100	item 类型: number
├─		非必须
strategyNum	number	非必须		出入策略编号，不传则使用出入系统配置的默认出入策略
isVaild	integer	非必须		是否生效，0-生效，1-不生效，不生效时删除权限，默认0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须			item 类型: object
├─ recNum	string	必须		权限记录号
├─ userNumber	string	必须		人员编号
├─ dotNum	string	必须		出入点编号
├─ strategyNum	string	必须		出入策略编号

根据第三方区域设置用户长效权限

基本信息

Version： ACS2.0.23.1130,ACS2.0.24.0923

Path： /api/v1/long/strategy/thirdArea

Method： POST

接口描述：

备注：中台和门禁都可以使用，门禁中使用单optNum不为空时会校验操作员应用授权和操作员数据范围。

24.0923冲刺：
1）增加请求参数optNum和remark
2）增加响应参数data

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
tenantNum	number	非必须		租户编号，不传则使用出入系统配置的默认租户编号
userNumbers	string []	必须		人员编号集合，上限1000	item 类型: string
├─		非必须
thirdAreaNums	number []	必须		第三方区域编号集合，上限100	item 类型: number
├─		非必须
strategyNum	number	非必须		出入策略编号，不传则使用出入系统配置的默认出入策略
isVaild	integer	非必须		是否生效，0-生效，1-不生效，不生效时删除权限，默认0
optNum	string	非必须		操作员编号
remark	string	非必须		备注，不能大于120个字符。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须			item 类型: object
├─ recNum	string	必须		权限记录号
├─ userNumber	string	必须		人员编号
├─ dotNum	string	必须		出入点编号
├─ strategyNum	string	必须		出入策略编号
├─ thirdAreaNum	string	必须		第三方区域编号

获取长效权限下发最大版本号

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/long/strategy/dd/fixId/max

Method： POST

接口描述：

24.0719冲刺
1、新增接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
recFlag	integer	必须		有效数据过滤标记：0-无效 1-有效 其它值-不过滤
dotNums	number []	必须		出入点编号集合	item 类型: number
├─		非必须
userNums	number []	必须		用户编号集合	item 类型: number
├─		非必须
strategyNums	number []	必须		出入策略编号集合	item 类型: number
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	number	必须		最大fixId

增量长效权限下发记录获取

基本信息

Version： ACS2.0.24.0719

Path： /api/v1/long/strategy/dd/incremental

Method： POST

接口描述：

24.0719冲刺
1、新增接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
limit	integer	非必须		数量, 默认10000，最大100000
gtFixId	number	非必须		开始版本号，获取版本号>gtFixId的数据
leFixId	number	非必须		结束版本号,获取版本号<=leFixId的数据
recFlag	string	非必须		有效数据过滤标记：0-无效 1-有效 其它值-不过滤
dotNums	number []	非必须		出入点编号集合	item 类型: number
├─		非必须
userNums	number []	非必须		用户编号集合	item 类型: number
├─		非必须
strategyNums	number []	非必须		出入策略编号集合	item 类型: number
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		返回状态码，200表示成功
msg	string	必须		返回描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	object []	必须		数据集合	item 类型: object
├─ recNum	number	必须		记录唯一编号
├─ userNum	number	必须		用户ID
├─ dotNum	number	必须		出入点编号
├─ strategyNum	number	必须		策略编号
├─ recFlag	number	必须		是否有效 0-否 1-是
├─ fixId	number	必须		版本号

分页查询长效权限

基本信息

Version： ACS2.0.24.0923

Path： /api/v1/long/strategy/page

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
current	string	非必须		当前页，默认1
pageSize	string	非必须		每页大小，默认10
countTotal	string	非必须		是否统计总数，0不统计，1 统计，默认0
userName	string	非必须		姓名（右模糊匹配）
userNumber	string	非必须		人员编号（右模糊匹配）
accountNumber	string	非必须		账号（右模糊匹配）
userClassId	string	非必须		用户分类ID（二级）
depId	string	非必须		组织机构ID
appId	string	非必须		应用来源
dotNums	string []	非必须		出入点编号集合	item 类型: string
├─		非必须
areaNums	string []	非必须		区域编号集合	item 类型: string
├─		非必须
thirdAreaNums	string []	非必须		第三方区域编号集合	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		200成功
msg	string	必须
sysCode	string	必须
data	object	必须
├─ total	string	必须		总数，请求参数countTotal不为0时有效
├─ records	object []	必须		用户长效权限详细信息	item 类型: object
├─ rowNum	string	必须		序号
├─ userNum	string	必须		用户唯一编号id
├─ userName	string	必须		姓名
├─ userNumber	string	必须		人员编号
├─ accountNumber	string	必须		用户账号
├─ classIds	string	必须		分类id
├─ classNames	string	必须		分类名称
├─ depIds	string	必须		用户所属机构ID
├─ depNames	string	必须		用户所属机构名称
├─ tenantNum	string	必须		租户编号
├─ areaNum	string	必须		区域编号
├─ areaName	string	必须		区域名称
├─ fullAreaName	string	必须		区域名称全路径
├─ thirdAreaNum	string	必须		第三方区域编号
├─ dotNum	string	必须		出入点编号
├─ dotName	string	必须		出入点名称
├─ strategyNum	string	必须		策略编号
├─ strategyName	string	必须		策略名称
├─ appId	string	必须		应用号
├─ appName	string	必须		应用名称
├─ setType	string	必须		进门权限的设置类型
├─ appUid	string	必须		应用系统的唯一号
├─ fixId	string	必须		版本号
├─ optNum	string	必须		操作员编号
├─ optName	string	必须		操作员名称

查询长短效权限下发状态

基本信息

Version： ACS2.0.24.0923

Path： /api/v1/longshort/strategy/downed

Method： POST

接口描述：

24.0923冲刺：
1）新增接口。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
recNums	object	必须		记录编号集合，上限1000个
type	string	必须		权限类型 1：长效 2：短效

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须		200成功
msg	string	必须
sysCode	string	必须
data	object []	必须			item 类型: object
├─ recNum	string	必须		权限记录号
├─ downed	integer	必须		下发状态：-1-待生成下发数据 0-未完成下发 1-完成下发 2-下发失败 3-未绑定设备
├─ downedTxt	string	必须		下发状态描述：-1-待生成下发数据 0-未完成下发 1-完成下发 2-下发失败 3-未绑定设备

出入点

增量获取出入点

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/dot/incremental

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
gtFixId	string	必须		出入点最小版本号，获取的出入点fixId > gtFixId
limit	number	非必须		数量, 默认1000，上限1000

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
sysCode	string	必须
time	string	必须
data	object []	必须			item 类型: object
├─ tenantNum	string	必须		租户编号
├─ appId	string	必须		应用ID
├─ dotNum	string	必须		出入点编号
├─ dotName	string	必须		出入点名称
├─ areaNum	string	必须		区域编号
├─ areaName	string	必须		区域名称
├─ fullAreaName	string	必须		区域全路径名称
├─ isPublic	number	必须		是否公用，0-否 1-是
├─ remark	string	必须		备注描述
├─ recFlag	number	必须		有效标记，0-无效 1-有效
├─ fixId	string	必须		版本号

获取出入点最大fixId

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/dot//fixId/max

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		状态码200成功，其他失败
msg	string	必须		描述信息
sysCode	string	必须		系统编码
time	string	必须		时间
data	string	必须		最大fixId

事件订阅

取消订阅出入事件

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/record/subscriptionUnByEventTypesAndAreaNum

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
subType	string	非必须		订阅类型（0-出入事件1-报警事件）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		成功返回200，失败返回错误码
msg	string	必须

按区域，事件类型新增订阅/变更订阅事件

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/record/subscriptionByEventTypesAndAreaNum

Method： POST

接口描述：

订阅方最多拥有一条报警事件和一条出入事件订阅信息，当之前已经有报警事件订阅信息或者出入事件订阅信息了，默认进行订阅变更的操作

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
eventMap	object	必须
├─ eventNums	string	非必须		事件类型
├─ isAll	string	必须		是否全部事件(0-全选，1-不全选)
callbackUrl	string	必须		指定事件接收的地址，支持http，样式如下：http://ip:port/eventRcv或者 https://ip:port/eventRcv
subType	string	必须		订阅类型（0订阅出入事件1订阅报警事件）
areaMap	object	必须
├─ areaNums	string	非必须		区域编号集合（区域类型集合）
├─ isAll	string	必须		是否全部区域(0-全选，1-不全选)
├─ numOrType	string	非必须		是否按区域编号或者区域类型（0-区域编号，1-区域类型)默认：0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	string	必须		成功返回200，失败返回错误码

推送数据接收接口

基本信息

Version： ACS2.0.23.1130

Path： /record/subscriptionByAreaNum

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
recordVOS	object	必须
├─ eventName	string	必须		事件名称
├─ eventNum	string	必须		事件序号
├─ ocurrTime	string	必须		发生时间（yyyy-MM-dd HH:mm:ss）
├─ userNum	string	必须		用户号
├─ userName	string	必须		姓名
├─ userNumber	string	必须		人员编号
├─ areaNum	string	必须		区域号
├─ areaName	string	必须		区域名称
├─ dotNum	string	必须		出入点号
├─ dotName	string	必须		出入点名称
├─ inOutType	string	必须		进出方向
├─ inOutName	string	必须		进出方向名称
├─ accountNumber	string	必须		账号
├─ classIds	string	必须		用户分类Id
├─ classNames	string	必须		用户分类名称
├─ depIds	string	必须		用户所属机构ID
├─ depNames	string	必须		用户所属机构名称
├─ mediumName	string	必须		识别方式名称
├─ mediumValue	string	必须		识别方式
├─ recNum	string	必须		记录号
├─ photoAddress	string	非必须		照片地址
├─ videoAddress	string	非必须		视频地址
├─ cardId	string	必须		卡号
├─ deviceName	string	必须		设备名称
├─ deviceNum	string	必须		设备编号
├─ serialNum	string	必须		设备序列号
├─ doorId	string	必须		门序号
├─ typeName	string	必须		设备类型
├─ modelName	string	必须		设备型号
├─ fixId	string	必须		版本号
├─ fullAreaName	string	必须		区域全路径
├─ thirdAreaNum	string	必须		第三方区域编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	string	必须		成功返回200，失败返回错误码

查询订阅信息

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/record/subscriptionView

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	必须
code	string	必须		成功返回200，失败返回错误码
data	object	必须
├─ records	object	必须
├─ eventNums	number []	必须		事件类型	item 类型: number
├─		非必须
├─ recNum	string	必须		记录号
├─ callbackUrl	string	必须		回调地址
├─ areaNums	string []	必须		区域号	item 类型: string
├─		非必须
├─ appId	string	必须		应用号
├─ subscriptionType	string	必须		订阅类型
├─ createTime	string	必须		创建时间
├─ fixId	string	必须		上一次推送版本号
├─ isAllFlag	string	必须		1-事件全订阅，2-区域全订阅，3-事件和区域全订阅，4-其他

区域

获取区域的最大版本号

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/area/getAreaMaxFixID

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
AppId		是		应用号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ maxFixId	string	必须		最大值版本号

增量获取区域

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/area/getAreaByFixId

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
startFixId	string	必须		开始版本号（包括开始版本号）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ records	object	必须
├─ areaNum	string	必须		区域号
├─ parentAreaNum	string	必须		父级区域号
├─ areaName	string	必须		区域名称
├─ bitInfo	string	必须		是否有效（0-无效，1-有效）
├─ fullAreaName	string	必须		全路径名
├─ fullAreaNum	string	必须		全路径区域号
├─ tenantNum	string	必须		维护的租户
├─ appId	string	必须		维护的应用
├─ createTime	string	必须		生成时间
├─ editTime	string	必须		修改时间
├─ remark	string	必须		备注
├─ fixId	string	非必须		版本号
├─ thirdAreaNum	string	非必须		第三方区域编号
├─ areaType	string	非必须		区域场景（1-大门、2-宿舍、3-办公室、4-场馆、5-会议室、6-实验室）
├─ parentThirdAreaNum	string	非必须		父级第三方区域编号
├─ thirdAreaType	string	非必须		区域类型（区域类型（1.学校2.校区3.楼群4.楼栋5.单元6.楼层7.空间））

批量删除区域

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/area/deleteThird

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
thirdAreaNums	number []	必须		第三方区域编号	item 类型: number
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ flag	string	必须
├─ errortxt	string	必须

修改区域

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/area/updateAreaThird

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
thirdAreaNum	string	必须		第三方区域编号
areaName	string	非必须		区域名称
areaType	string	非必须		区域场景（1.大门2.宿舍3.办公室4.场馆5.会议室6.实验室）传空字符串表示清空场景类型，不传则表示不需要修改
remark	string	非必须		区域描述
thirdAreaType	string	非必须		区域类型（区域为空的时候，才会修改）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

新增区域

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/area/insertAreaThird

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		应用号

Body

名称	类型	是否必须	默认值	备注	其他信息
parentThirdAreaNum	string	必须		父级区域编号（如果是根节点传0）
areaName	string	必须		区域名称
areaType	string	非必须		区域场景（1.大门2.宿舍3.办公室4.场馆5.会议室6.实验室）
thirdAreaType	string	非必须		区域类型（1.学校2.校区3.楼群4.楼栋5.单元6.楼层7.空间）
thirdAreaNum	string	必须		第三方编号
remark	string	非必须		备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

区域巡检

区域巡检 下发指令

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/device/sendCommand

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
deviceNum	string	非必须		设备编号 和 设备序列号 两者有一个不能为空 给自主设备下发时不能为空
serialNum	number	非必须		设备序列号和设备编号两者有一个不能为空 给自主设备下发时不能为空
doorId	string	非必须		门序号
doorNum	string	非必须		门编号
commandId	string	必须		1：开门，2：重启，3：开启消防，4：解除消防(目前仅支持1)
userId	string	非必须		用户ID，给掌门设备发送指令时必传

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		状态码 200 成功，其他失败
msg	string	非必须		描述
sysCode	string	非必须
time	string	非必须
data	string	非必须

区域巡检设备列表 全查

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/regionalPatrol/getRegionalPatrolList

Method： POST

接口描述：

2023年10月23日 出参增加
tkControlError 梯控面板异常标记 1 异常 0 或空不异常
tkControlErrorContent 梯控面板异常内容
subDevCount 梯控下门的数量就是层数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
areaNums	string []	非必须		园区编号数组	item 类型: string
├─		非必须
areaNumIsNull	number	必须		是否查询区域为空的数据，1 是，0 否，当值=0时，areaNums不能为空
doorStatus	string []	非必须		门状态 1:门开启 ,2:门关闭,3:摄像头异常,4:扫码头异常,5:消防报警,11:控制器扫码头损坏，12:控制器摄像头损坏,13:控制器NFC损坏	item 类型: string
├─		非必须
areaNumFlag	string	必须		0 第三方的区域编号，1门禁的区域编号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		状态码 200 成功，其他失败
msg	string	非必须		描述
sysCode	string	非必须
time	string	非必须
data	object	非必须
├─ records	object []	非必须		业务数据	item 类型: object
├─ deviceNum	string	必须		设备编号
├─ deviceName	string	必须		设备名称
├─ modelNum	number	必须		设备型号编号
├─ areaNum	number	必须		区域编号
├─ modelName	string	必须		设备型号名称
├─ typeName	string	必须		设备类型名称
├─ serialNum	string	必须		设备序列号
├─ categoryNum	number	必须		设备大类编号
├─ categoryName	string	必须		设备大类名称
├─ parentDeviceNum	string	必须		父级节点编号
├─ devStatus	number	必须		在线状态
├─ devStatusName	string	必须		在线描述
├─ fullAreaName	string	必须		区域全路径
├─ areaName	string	必须		区域名称
├─ doorInfoVOList	object []	必须			item 类型: object
├─ deviceNum	string	必须		门设备号
├─ parentDeviceNum	string	必须		上级设备编号
├─ deviceName	string	必须		门名称
├─ unknownIsOff	string	必须		门是状态未知 1是 0否
├─ fireFightingIsOff	string	必须		消防是开启 1开启 0 关闭
├─ scanCodeIsOff	string	必须		扫码头是异常 1 是 0 否
├─ cameraIsOff	string	必须		摄像头是损坏状态 1 是 0 否
├─ doorIsOff	string	必须		门是开启状态 1 开 0 关 2 未知状态
├─ deviceId	string	必须		门序号
├─ doorFireFlag	string	必须		消防按钮是否能点击 1 是 0 否
├─ doorStatusFlag	string	必须		是否有门状态信息，1 有 0 没有
├─ deviceTemperature	string	必须		设备温度
├─ deviceHumidity	string	必须		设备湿度
├─ modelFlag	string	必须		门的对接模式 0 门禁模式 1 闸机模式(普通) 2 闸机模式(串口)
├─ controllerNFCDamaged	number	必须		控制器NFC损坏 1是损坏 0没事
├─ controllerCameraDamaged	number	必须		控制器摄像头损坏 1是损坏 0没事
├─ controllerSweepDockDamaged	number	必须		控制器扫码头损坏 1是损坏 0没事
├─ deviceElectricQuantity	number	必须		电量
├─ controlWarning	string	必须		警告
├─ controlDisconnection	string	必须		断路
├─ controlShortCircuit	string	必须		短路
├─ controlMalfunction	string	必须		故障
├─ thirdDevice	string	必须		是第三方的1，门禁设备:0 默认0
├─ tkControlError	number	非必须		梯控面板异常标记 1 异常 0 或空不异常
├─ tkControlErrorContent	string	非必须		梯控面板异常内容
├─ subDevCount	number	非必须		梯控下门的数量就是层数

区域巡检设备列表 分页

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/regionalPatrol/getRegionalPatrolListPage

Method： POST

接口描述：

2023年10月23日 出参增加
tkControlError 梯控面板异常标记 1 异常 0 或空不异常
tkControlErrorContent 梯控面板异常内容
subDevCount 梯控下门的数量就是层数

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
AppId		是		需接入出入系统的第三方应用号，可从授权管理平台中对应应用详情中查看

Body

名称	类型	是否必须	默认值	备注	其他信息
areaNums	string []	非必须		园区编号数组	item 类型: string
├─		非必须
areaNumIsNull	number	必须		是否查询区域为空的数据，1 是，0 否，当值=0时，areaNums不能为空
doorStatus	string []	非必须		门状态 1:门开启 ,2:门关闭,3:摄像头异常,4:扫码头异常,5:消防报警,11:控制器扫码头损坏，12:控制器摄像头损坏,13:控制器NFC损坏	item 类型: string
├─		非必须
areaNumFlag	string	必须		0 第三方的区域编号，1门禁的区域编号
current	string	非必须		当前第几页
pageSize	string	非必须		一页多少条

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		状态码 200 成功，其他失败
msg	string	非必须		描述
sysCode	string	非必须
time	string	非必须
data	object	非必须
├─ records	object []	非必须		业务数据	item 类型: object
├─ deviceNum	string	必须		设备编号
├─ deviceName	string	必须		设备名称
├─ modelNum	number	必须		设备型号编号
├─ areaNum	number	必须		区域编号
├─ modelName	string	必须		设备型号名称
├─ typeName	string	必须		设备类型名称
├─ serialNum	string	必须		设备序列号
├─ categoryNum	number	必须		设备大类编号
├─ categoryName	string	必须		设备大类名称
├─ parentDeviceNum	string	必须		父级节点编号
├─ devStatus	number	必须		在线状态
├─ devStatusName	string	必须		在线描述
├─ fullAreaName	string	必须		区域全路径
├─ areaName	string	必须		区域名称
├─ doorInfoVOList	object []	必须			item 类型: object
├─ deviceNum	string	必须		门设备号
├─ parentDeviceNum	string	必须		上级设备编号
├─ deviceName	string	必须		门名称
├─ UnknownIsOff	string	必须		门是状态未知 1是 0否
├─ fireFightingIsOff	string	必须		消防是开启 1开启 0 关闭
├─ scanCodeIsOff	string	必须		扫码头是异常 1 是 0 否
├─ cameraIsOff	string	必须		摄像头是损坏状态 1 是 0 否
├─ doorIsOff	string	必须		门是开启状态 1 开 0 关 2 未知状态
├─ deviceId	string	必须		门序号
├─ doorFireFlag	string	必须		消防按钮是否能点击 1 是 0 否
├─ doorStatusFlag	string	必须		是否有门状态信息，1 有 0 没有
├─ deviceTemperature	string	必须		设备温度
├─ deviceHumidity	string	必须		设备湿度
├─ modelFlag	string	必须		门的对接模式 0 门禁模式 1 闸机模式(普通) 2 闸机模式(串口)
├─ controllerNFCDamaged	number	必须		控制器NFC损坏 1是损坏 0没事
├─ controllerCameraDamaged	number	必须		控制器摄像头损坏 1是损坏 0没事
├─ controllerSweepDockDamaged	number	必须		控制器扫码头损坏 1是损坏 0没事
├─ deviceElectricQuantity	number	必须		电量
├─ controlWarning	string	必须		警告
├─ controlDisconnection	string	必须		断路
├─ controlShortCircuit	string	必须		短路
├─ controlMalfunction	string	必须		故障
├─ thirdDevice	string	必须		是第三方的1，门禁设备:0 默认0
├─ tkControlError	number	非必须		梯控面板异常标记 1 异常 0 或空不异常
├─ tkControlErrorContent	string	非必须		梯控面板异常内容
├─ subDevCount	number	非必须		梯控下门的数量就是层数

设备

设备状态订阅

基本信息

Version： ACS2.0.23.1130

Path： /api/v1/subscription/ecpDeviceStatus

Method： POST

接口描述：

请求参数是 body 里面的json 字符串

请求参数

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		状态吗
msg	string	非必须		信息描述
sysCode	string	非必须		系统编码
time	string	非必须		响应时间
data	string	非必须

易通对外webapi转移

修改临时进门权限

基本信息

Version： ACS2.0.24..0402

Path： /api/common/infoqueryservice/updateTemporaryAuth

Method： POST

接口描述：

接口现在只支持按recId进行修改，暂时不支持按recDate，recId，deviceNums，perCode进行批量修改

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号（融合的人员编号）
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复（出入点编号）
recDate	text	是	2022-03-04	临时门禁权限日期
beginTime	text	是	0030	开始时间段
endTime	text	是	0150	结束时间段
recId	text	是	1	权限时段记录号（权限记录号）
sign	text	是		目前默认提供MD5算法 后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是	1	使用单位号（ 出入不使用这个字段，直接传1即可）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		返回码
msg	string	非必须		返回消息

删除临时进门权限

基本信息

Version： ACS2.0.24..0402

Path： /api/common/infoqueryservice/deleteTemporaryAuth

Method： POST

接口描述：

接口现在只支持按recId进行删除，暂时不支持按recDate，recId，deviceNums，perCode进行批量删除

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号（融合的人员编号）
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复（出入点编号）
recDate	text	是	2021-10-19	临时门禁权限日期
recId	text	是	1	权限时段记录号（权限记录号）
sign	text	是		目前默认提供MD5算法 后续推出SHA DES RSA 具体查看【开始开发-签名指南】
epId	text	是		使用单位号（出入不使用这个字段，传1即可）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		返回码
msg	string	非必须		返回消息

变更进出权限（可批量）

基本信息

Version： ACS2.0.24..0402

Path： /api/common/systemdocking/updateaccroompower

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是		个人编号 （可传多个个人编号','分隔 例：11,22,33）（融合的人员编号）
doorNum	text	是		门编号 (可传多个门号','分隔 例：1,2,3,4)（出入点编号）
validTime	text	是		生效时间(格式必须为yyyy-MM-dd HH:mm:ss)（仅易通需要）
dpFixId	text	是		对接方的门禁权限版本号（如果不需要同步权限，只需要变更权限功能的，传0即可）
isVaild	text	是		是否生效，0-生效，1-不生效，不生效的时候删除权限
optNum	text	是		操作员编号，易通平台需要，由易通系统创建好后分配
durationId	text	否		营业时段分组编号（允许进出时段组中的分组，未传时使用最小的营业时段分组编号）（nacos上面配置，默认为1）
disableTime	text	否		失效时间(格式必须为yyyy-MM-dd HH:mm:ss)（仅易通需要）
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		错误码
msg	string	非必须		错误信息

新增临时进门权限

基本信息

Version： ACS2.0.24..0402

Path： /api/common/infoqueryservice/insertTemporaryAuth

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号（融合的人员编号）
deviceNums	text	是	1,2,3	门设备编号，可以批量以逗号连接，请注意不要重复（出入点编号）
recDate	text	是	2022-03-04	临时门禁权限日期
beginTime	text	是	0030	开始时间段
endTime	text	是	0150	结束时间段
sign	text	是		目前默认提供MD5算法 后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是	1	使用单位号（出入不使用和这个字段，传1即可）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
data	object []	非必须			item 类型: object
├─ beginTime	string	必须		开始时间
├─ deviceNum	number	必须		设备编号（出入点编号）
├─ endTime	string	必须		结束时间
├─ percode	string	必须		人员编号（融合的人员编号）
├─ recDate	string	必须		权限日期
├─ recid	number	必须		权限记录号，修改删除时需要使用（权限记录号）
msg	string	非必须

查询临时进门权限

基本信息

Version： ACS2.0.24..0402

Path： /api/common/infoqueryservice/queryTemporaryAuth

Method： POST

接口描述：

该接口查询参数recDate会查询当日及以后的所有权限
perCode与deviceNums可以同时都传，也可以单独传一个，但不能都不传
单独传perCode会查询该人所有门的权限
单独传deviceNums会查询该门所有人的权限
两个都传会查询该人在该门下的权限

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
perCode	text	是	2014010101	个人编号，具体细节请看备注
deviceNums	text	是	1	门设备编号，不能批量，具体细节请看备注
recDate	text	是	2021-10-19	临时门禁时间，会查询出当日及以后所有的权限
sign	text	是		目前默认提供MD5算法 后续推出SHA DES RSA 具体查看【开始开发-签名指南】。
epId	text	是		使用单位号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		返回码
data	object []	非必须			item 类型: object
├─ deviceNum	number	必须		门设备编号（出入点编号）
├─ accNum	string	必须		账号（融合userid）
├─ accName	string	必须		账户名称
├─ epId	number	必须		使用单位号（对应入参epid）
├─ beginTime	string	必须		开始时间段
├─ endTime	string	必须		结束时间段
├─ deviceName	string	必须		设备名称（出入点名称）
├─ recDate	string	必须		临时门禁权限日期
├─ recId	number	必须		权限时段记录号，修改删除时使用（权限的记录号）
├─ perCode	string	必须		个人编号（融合的人员编号）
msg	string	非必须

获取人员进出新增记录

基本信息

Version： ACS2.0.24..0402

Path： /api/common/systemdocking/getaccdoorrecordsbyfixid

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
startDrFixId	text	是		起始版本号
endDrFixId	text	是		结束版本号
doorNum	text	否		门编号(40为必传参数)（出入点编号）
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		错误码
msg	string	非必须		错误信息
data	object	非必须
├─ list	object	非必须
├─ drFixId	string	非必须		版本号
├─ eventId	string	非必须		事件编号（事件类型）
├─ doorNum	string	非必须		门编号（出入点编号）
├─ accNum	string	非必须		账号（融合中的账号）
├─ inOrOutCode	string	非必须		进出方向（0未知，1进，2出）
├─ occurTime	string	非必须		门禁事件发生时间 yyyy-MM-dd HH:mm:ss
├─ perCode	string	非必须		个人编号（融合中人员编号）
├─ doorName	string	非必须		门名称（出入点名称）
├─ accName	string	非必须		卡户姓名
├─ sign	string	非必须		签名
├─ count	string	非必须		数据条数
├─ currentDrFixId	string	非必须		当前数据中最大版本号

获取指定门的人员进出记录当前版本号

基本信息

Version： ACS2.0.24..0402

Path： /api/common/systemdocking/getaccdoorrecordsfixid

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
doorNum	text	否		门编号（出入点编号）
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ doorNum	string	非必须		门编号（出入点编号）
├─ drFixId	string	非必须		当前门的进出记录版本号
├─ sign	string	非必须		签名

门禁流水查询

基本信息

Version： ACS2.0.24..0402

Path： /api/common/infoqueryservice/queryacceventrecord?access_token={access_token}

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

路径参数

参数名称	示例	备注
access_token

Body

参数名称	参数类型	是否必须	示例	备注
accNum	text	否	1	账号
optNum	text	否	1001	操作员编号，接易通必须传（出入不使用这个字段，传1001即可）
start	text	是	1	从第几条开始
limit	text	是	20	每页限制几条
startTime	text	是	2019-01-01 12:12:12	查询起期
endTime	text	是	2019-01-01 12:12:12	查询止期
inOrOut	text	否	1	进出门方向 1-进 2-出 （易通）
enterType	text	否	1	进门方式，0-刷卡（默认） 1-刷脸 2-虹膜 3-指纹 4-扫码（易通）（出入当前只有0，1，4）
eventIds	text	否	1,2	门禁事件编号 多个以英文逗号","分隔 （事件类型）
clsNum	text	否	1	卡户身份编号（融合的用户分类）
accDepts	text	否	1,2,3	账户部门范围，多个账户部门编号以英文逗号","分隔（用户的组织机构）
deviceNums	text	否	756,856	平台门禁机设备的设备编号，多个设备编号以英文逗号","分隔（易通）（出入的平台设备号）
doorNums	text	否	1,2,3	门编号，多个以英文逗号","分隔（出入点编号）
orderType	text	否	0	0-升序，1-降序，不传，默认升序（按版本号）
sign	text	是		签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ sign	string	必须		签名
├─ count	string	必须		总条数
├─ list	object	必须
├─ recId	string	必须		事件记录号
├─ cardSID	string	必须		卡号
├─ accNum	string	必须		帐号
├─ accName	string	必须		姓名
├─ accDepFullPath	string	非必须		部门全路径（如果账号有多个组织机构，则只返回第一个组织机构的全路径）
├─ percode	string	必须		个人编号（融合中的人员编号）
├─ ocurrDateTime	string	必须		事件发生时间
├─ deviceNum	string	非必须		设备编号(ET5.1.23.1231增加)（出入中台的设备编号）
├─ deviceName	string	非必须		设备名称
├─ doorNum	string	非必须		门编号(ET5.1.23.1231增加)（出入点名称）
├─ doorName	string	非必须		门名称（出入点名称）
├─ enterTypeName	string	非必须		进门方式名称
├─ deviceSN	string	非必须		设备序列号
├─ enterType	string	非必须		事件触发类别 0-刷卡，1-人脸，2-虹膜，3-指纹 4-二维码（40 0-刷卡，1-人脸，2-二维码，3-指纹）
├─ eventName	string	非必须		触发事件名称
├─ inOrOutName	string	非必须		进出方向（40不支持）