g82tt/SecMPS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8413a52a281d2347eb293a372e72cceb2e3962a9
SecMPS/doc/对接文档/钥匙管理系统接口_提取.txt

9534 lines
107 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
智能钥匙管理系统
软 件 接 口 说 明书
V1.0.4
承建单位：沈阳欧通宝科技有限公司
二〇二三年六月
版本修订批准记录
【 历次版本修订记录，版本修订描述重要说明】
修订日期
版本号
版本修订描述
修订人
2023-06-20
1.0.0
创建
周鑫
2023-07-19
1.0.1
添加2.18开放接口
周鑫
2023-08-29
1.0.2
修改“2.18.2批量删除员工”接口传参方式
周鑫
2023-09-06
1.0.3
添加2.18.8 单点登录接口
周鑫
2023-09-12
1.0.4
2.18.3 批量同步员工接口添加登录账号account
周鑫
目录
智能钥匙管理系统1
V1.0.41
1.概述8
1.1 编写目的8
1.2 阅读对象8
1.3 接口调用流程8
2.接口列表9
2.3 交接记录管理9
2.3.1 查询交接详情列表10
2.3.2 查询交接记录列表12
2.4 借还&授权记录管理15
2.4.1 查询借还记录列表15
2.4.2 查询授权记录列表17
2.4.3 远程授权19
2.6 员工可借/可授权钥匙关联管理23
2.6.1 关联员工可借/可授权钥匙23
2.6.2 查询员工可借/可授权钥匙24
2.7 员工管理25
2.7.1 新增员工25
2.7.2 修改员工28
2.7.3 查询员工列表31
2.7.4 删除员工管理36
2.7.5 获取员工详细信息37
2.9 Token 管理42
2.11 部门管理43
2.12 钥匙授权信息管理46
2.12.1 获取钥匙授权信息详细信息46
2.14 钥匙管理47
2.14.1 新增钥匙47
2.14.2 修改钥匙50
2.14.4 查询钥匙列表53
2.14.5 查询可借钥匙62
2.14.6 查询可借钥匙员工列表64
2.14.7 删除钥匙管理70
2.14.8 获取钥匙详细信息71
2.16 锁柜管理76
2.16.1 新增锁柜76
2.16.2 修改锁柜78
2.16.3 查询锁柜列表79
2.16.4 删除锁柜84
2.16.5 获取锁柜详细信息84
2.16.6 首页统计图88
2.17 锁芯管理90
2.17.1 修改锁芯90
2.17.2 查询锁芯列表91
2.17.3 删除锁芯117
2.17.4 获取锁芯详细信息118
2.18 开放接口125
2.18.1 心跳接口125
2.18.2 批量删除员工125
2.18.3 批量同步员工126
2.18.4 查询钥匙柜中所有钥匙信息131
2.18.5 查询授权记录列表接口134
2.18.6 查询借还记录列表接口137
2.18.7 查询告警记录列表接口140
2.18.8 单点登录接口143
3.统一响应状态144
4.数据字典145
2.7.1 新增员工 36
2.7.2 修改员工 39
2.7.3 查询员工列表 42
2.7.4 删除员工管理 47
2.7.5 获取员工详细信息 48
2.8 员工组管理 53
2.8.1 新增员工组 53
2.8.2 修改员工组 55
2.8.3 员工组分配员工 56
2.8.4 导出员工组列表 57
2.8.5 查询员工组列表 59
2.8.6 删除员工组 63
2.8.7 获取员工组详细信息 64
2.9 Token 管理 68
2.9.1 获取 Token 68
2.10 组间互斥分组管理 69
2.10.1 新增组间互斥分组 69
2.10.2 修改组间互斥分组 71
2.10.3 导出组间互斥分组列表 73
2.10.4 查询组间互斥分组列表 74
2.10.5 删除组间互斥分组 76
2.10.6 获取组间互斥分组详细信息 77
2.11 部门管理 79
2.11.1 根据用户 ID 获取部门信息 79
2.12 钥匙授权信息管理 81
2.12.1 获取钥匙授权信息详细信息 81
2.13 钥匙申请单管理 82
2.13.1 新增钥匙申请单 82
2.13.2 修改钥匙申请单 85
2.13.3 远程申请借钥匙 88
2.13.4 导出钥匙申请单列表 91
2.13.5 查询钥匙申请单列表 92
2.13.6 远程授权钥匙 96
2.13.7 删除钥匙申请单 98
2.13.8 获取钥匙申请单详细信息 99
2.14 钥匙管理 101
2.14.1 新增钥匙 101
2.14.2 修改钥匙 103
2.14.4 查询钥匙列表 106
2.14.5 查询可借钥匙 113
2.14.6 查询可借钥匙员工列表 115
2.14.7 删除钥匙管理 120
2.14.8 获取钥匙详细信息 121
2.15 钥匙组管理 126
2.15.1 新增钥匙组 126
2.15.2 修改钥匙组 127
2.15.3 钥匙组分配钥匙 129
2.15.4 导出钥匙组列表 130
2.15.5 查询钥匙组列表 131
2.15.6 删除钥匙组 137
2.15.7 获取钥匙组详细信息 137
2.16 锁柜管理 142
2.16.1 新增锁柜 142
2.16.2 修改锁柜 144
2.16.3 查询锁柜列表 145
2.16.4 删除锁柜 150
2.16.5 获取锁柜详细信息 150
2.16.6 首页统计图 154
2.17 锁芯管理 156
2.17.1 修改锁芯 156
2.17.2 查询锁芯列表 157
2.17.3 删除锁芯 174
2.17.4 获取锁芯详细信息 175
2.18 开放接口 182
2.18.1 心跳接口 182
2.18.2 批量删除员工 182
2.18.3 批量同步员工 183
2.18.4 查询钥匙柜中所有钥匙信息 188
2.18.5 查询授权记录列表接口 191
2.18.6 查询借还记录列表接口 194
2.18.7 查询告警记录列表接口 197
2.18.8 单点登录接口 200
3.统一响应状态 201
4.数据字典 201
1.概述
1.1 编写目的
本文档是对智能钥匙管理系统接口对接的基本描述，用于规范和指导其他厂商对接钥匙柜管理系统。
1.2 阅读对象
与智能钥匙管理系统对接厂商相关软件开发人员、运维人员等。
1.3 接口调用流程
1. 接口地址中的 serverIp：钥匙柜管理系统接口服务 ip, 接口地址中的 port：钥匙柜管理系统接口服务端口；
2. 向钥匙柜系统申请接口调用账号 clientId 和密码 clientSecret；
3. 使用申请的账号密码调用“2.9. l 获取 Token”接口，获取 token（有效期 30 分钟，超期需重新获取）；
4. 除“2.9. l 获取 Token ”、“2. l8. l 心跳接口”外，调用业务接口时添加 Authorization认证（类型为 Bearer Token ，值为调用“2.9. l 获取 Token”接口返回的 token 值）,如下图：
2.接口列表
2.3 交接记录管理
2.3.1 查询交接详情列表
接口地址
GET http://serverIp:port/prod-api/kms/handover/handoverInfolist接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
handoverId
交接 id
query
true
string
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
交接详情视图对象
borrowTime
借用时间
string(date-time)
code
锁柜编号
string
createUserId
创建人
integer(int64)
handoverId
交接 id
string
id
id
string
lendStaffName
借用人姓名
string
参数名称
参数说明
类型
备注
lockerId
锁柜 ID
integer(int64)
lockerName
锁柜名称
string
lockholeSort
锁芯序号
integer(int64)
openerId
钥匙 id
integer(int64)
openerName
钥匙名称
string
openerState
钥匙状态
string
openerType
钥匙类型
string
updateUserId
修改人
integer(int64)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 1,
"rows": [ {
"id": "2823903762593611778",
"handoverId": "2823903762581028864", "openerId": 2020,
"openerName": "四楼库房钥匙",
"lockerId": 25,
"code": "888",
"lockerName": "10 位对外公用钥匙柜", "lockholeSort": 9,
"openerType": "免授权",
"openerState": "借出",
"createUserId": 2294,
"updateUserId": 2294,
"lendStaffName": "操作员",
"borrowTime": "2023-02-17 10:15:17" }
],
"code": 200,
"msg": "查询成功" }
2.3.2 查询交接记录列表
接口地址
GET http://serverIp:port/prod-api/kms/handover/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
lockerName
锁柜名称
query
true
string
fromUser
交班人名字
query
false
string
fromUserCard
交班人 ic 卡号
query
false
string
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
toUser
接班人名字
query
false
string
toUserCard
接班人 ic 卡号
query
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
交接记录视图对象
参数名称
参数说明
类型
备注
code
锁柜编号
string
createTime
创建时间
string(date-time)
createUser
创建人
string
createUserId
创建人 id
integer(int64)
fromUser
交班人名字
string
fromUserCard
交班人 ic 卡号
string
fromUserComment
交班人备注
string
fromUserId
交班人 id
integer(int64)
id
id
string
inNum
在柜数量
integer(int32)
lockerId
锁柜 ID
integer(int64)
lockerName
锁柜名称
string
lossNum
丢失数量
integer(int32)
outNum
借出数量
integer(int32)
toUser
接班人名字
string
toUserCard
接班人 ic 卡号
string
toUserComment
接班人备注
string
toUserId
接班人 id
integer(int64)
totalNum
总数
integer(int32)
updateUser
更新人
string
参数名称
参数说明
类型
备注
updateUserId
更新人 id
integer(int64)
writeNum
录入数量
integer(int32)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 1,
"rows": [ {
"id": "2793454178000175104",
"lockerId": 7,
"lockerName": "测试柜 1",
"code": "103",
"fromUserId": 2209,
"fromUser": "核电维管操作员",
"fromUserCard": "asd",
"fromUserComment": null,
"toUserId": 2223,
"toUser": "操作员",
"toUserCard": "3950717298",
"toUserComment": "测试交接",
"totalNum": 48,
"outNum": 2,
"inNum": 44,
"lossNum": 1,
"writeNum": 1,
"createUserId": 2223,
"createUser": "操作员",
"updateUserId": 2223,
"updateUser": "操作员",
"createTime": "2022-11-25 09:44:43" }
],
"code": 200,
"msg": "查询成功" }
2.4 借还&授权记录管理
2.4.1 查询借还记录列表
接口地址
GET http://serverIp:port/prod-api/kms/permission/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
backStaffName
归还员工名称
query
true
string
lendStaffName
借出员工名称
query
true
string
lockerName
锁柜名称
query
true
string
openerCnName
钥匙名称
query
true
string
openerState
钥匙状态：1.借出，2.归还
query
true
integer(int32)
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
query
true
integer(int32)
beginApplyTime
申请时间起始日期：YYYY-MM-DD HH:mm:ss
query
false
string
endApplyTime
申请时间结束日期：YYYY-MM-DD HH:mm:ss
query
false
string
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
借还&授权记录视图对象
applyTime
申请时间
string(date- time)
backStaffName
归还员工名称
string
backTime
归还时间
string(date- time)
borrowTime
借出时间
string(date- time)
lendStaffName
借出员工名称
string
lockerName
锁柜名称
string
lockholeSort
锁芯序号
integer(int64)
openerCnName
钥匙名称
string
openerState
钥匙状态：1.借出，2.归还
integer(int32)
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
integer(int32)
permissionState
授权状态：1.授权中，2.授权失败，3.授权成功，4.授权过期
integer(int32)
remark
备注
string
uuid
全局唯一主键
string
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"code": 0, "msg": "", "rows": [
{
"applyTime": "","backStaffName": "", "backTime": "","borrowTime": "","lendStaffName": "", "lockerName": "","lockholeSort": 0,"openerCnName": "","openerState": 0,"openerType": 0,"permissionState": 0, "remark": "","uuid": ""}],"total": 0}
"applyTime": "",
"backStaffName": "", "backTime": "",
"borrowTime": "",
"lendStaffName": "", "lockerName": "",
"lockholeSort": 0,
"openerCnName": "",
"openerState": 0,
"openerType": 0,
"permissionState": 0, "remark": "",
"uuid": ""
}
],
"total": 0
}
2.4.2 查询授权记录列表
接口地址
GET http://serverIp:port/prod-api/kms/permission/listPer
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
backStaffName
归还员工名称
query
true
string
lendStaffName
借出员工名称
query
true
string
lockerName
锁柜名称
query
true
string
openerCnName
钥匙名称
query
true
string
openerState
钥匙状态：1.借出，2.归还
query
true
integer(int32)
openerType
钥匙类型：1.无授权，2.一次授权， 3.二次授权
query
true
integer(int32)
参数名称
参数说明
请求类型
必须
数据类型
备 注
applyTime
申请时间
query
false
string(date- time)
backTime
归还时间
query
false
string(date- time)
beginApplyTime
申请时间起始日期：YYYY-MM-DD
HH:mm:ss
query
false
string
endApplyTime
申请时间结束日期：YYYY-MM-DD
HH:mm:ss
query
false
string
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
借还&授权记录视图对象
applyTime
申请时间
string(date- time)
backStaffName
归还员工名称
string
backTime
归还时间
string(date- time)
borrowTime
借出时间
string(date- time)
lendStaffName
借出员工名称
string
lockerName
锁柜名称
string
lockholeSort
锁芯序号
integer(int64)
openerCnName
钥匙名称
string
参数名称
参数说明
类型
备注
openerState
钥匙状态：1.借出，2.归还
integer(int32)
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
integer(int32)
permissionState
授权状态：1.授权中，2.授权失败，3.授权成功，4.授权过期
integer(int32)
remark
备注
string
uuid
全局唯一主键
string
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 0,
"rows": [{
"uuid": "c2e075c7-7ed5-49c4-b899-a7e703cdc2d6", "lockerName": "测试",
"lockholeSort": 3,
"openerCnName": "测试钥匙 1",
"openerType": 3,
"lendStaffName": "张三",
"backStaffName": "张三",
"openerState": 2,
"permissionState": 3,
"applyTime": "2023-06-14 09:06:21",
"borrowTime": "2023-06-14 09:06:39",
"backTime": "2023-06-14 09:07:32",
"remark": null }],
"code": 200,
"msg": "查询成功" }
2.4.3 远程授权
接口地址
POST http://serverIp:port/prod-api/kms/permission/remote
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
openerPermissionUuid: "b991ab8d-de07-4ede-9da7-f35123e34326",
state: true }
请求参数
参数名称
参数说明
请 求 类 型
必须
数据类型
备注
permissionCmdData
PermissionCmdData
body
true
PermissionCmdData
PermissionCmdData
borrowOk
false
boolean
openerPermissionUuid
true
string
permissionType
false
integer(int32)
remark
false
string
staffId
false
integer(int64)
state
true
boolean
true:允许借
用;false:拒绝借用
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 0,
"msg": ""
}
2.5 告警记录管理
2.5.1 查询告警记录列表
接口地址
GET http://serverIp:port/prod-api/kms/warning/list接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备 注
openerCnName
钥匙名称
query
true
string
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
query
true
integer(int32)
staffName
借出员工
query
true
string
beginWarningTime
query
false
string
endWarningTime
query
false
string
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
type
告警类型：1、当前告警；2 历史告警
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
参数名称
参数说明
类型
备注
msg
消息内容
string
rows
列表数据
array
告警记录视图对象
borrowTime
借出时间
string(date- time)
lockerName
锁柜名称
string
lockholeSort
锁芯序号
integer(int64)
openerCnName
钥匙名称
string
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
integer(int32)
permissionUuid
同步到后台 Permission 主键
string
remark
备注
string
staffName
借出员工
string
type
告警类型：1、当前告警；2 历史告警
integer(int32)
uuid
同步到后台的主键
string
warningTime
告警时间
string(date- time)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"code": 0,
"msg": "",
"rows": [ {
"borrowTime": "",
"lockerName": "", "lockholeSort": 0,
"openerCnName": "",
"openerType": 0,
"permissionUuid": "",
"remark": "",
"staffName": "",
"type": 0,
"uuid": "",
"warningTime": ""
}
],
"total": 0
}
2.6 员工可借/可授权钥匙关联管理
2.6.1 关联员工可借/可授权钥匙
约束条件
只有钥匙柜状态为在线状态时，配置人员可借/可授权钥匙时才可修改是否选中，即离线的钥匙保持原状态不可修改。
接口地址
POST http://serverIp:port/prod-api/kms/staffopener/available 接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{"staffIds": [3],
{
"staffIds": [3],
"openerIds": [1], "type":1
}
请求参数
参数名称
参数说明
请求类型
必 须
数据类型
备注
员工可借钥匙关联业务对象
员工可借钥匙关联业务对象
body
true
员工可借钥匙关联业务对象
员工可借钥匙关联业务对象
openerIds
钥匙 ID 列表
true
array
钥匙 id 数组
staffIds
员工 ID 列表
true
array
人员 id 数组
type
类型
true
integer(int32)
类型：1、可借钥
匙；2、可授权钥匙
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.6.2 查询员工可借/可授权钥匙
接口地址
GET http://serverIp:port/prod-api/kms/staffopener/listall接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
staffId
员工 id
query
true
integer(int64)
type
类型
query
true
integer(int32)
类型：1、可借钥匙；2、可授权钥匙
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
参数名称
参数说明
类型
备注
data
数据对象
object
id
id
integer
staffId
员工 id
string
openerId
钥匙 id
string
type
类型：1、可借钥匙；2、可授权钥匙
integer
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": [
{
"id": 3,
"staffId": 3, "openerId": 1, "type": 1
}
]
}
2.7 员工管理
2.7.1 新增员工
接口地址
POST http://serverIp:port/prod-api/kms/staff
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"allowKeyAmount": 100,
"cardNo": "6435412631523", "cascadeCreateUser": faıse, "deptId":129,
"overdue": 0,
"endTime": "2023-06-21",
"faceImgUrl": "http://192.168.0.25:20000/headImg/33fdf07084cd4aab3e53be2c99529916.jpg
",
"mobile": "15912345676", "name": "张三",
"state": 1,
"type": 1,
"uname": "tdwy", "upwd": "123"
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
员工管理业务对象
员工管理业务对象
body
true
员工管理业务对象
员工管理业务对象
allowKeyAmount
可借取钥匙数量
true
integer(int64)
cardNo
卡号
true
string
发卡器识别 IC 卡号
cascadeCreateUser
是否级联创
建系统用户
false
boolean
固定值 false
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
true
integer(int64)
可设置固定值 129 （sys_dept 表 id）
endTime
有效期截止时间
false
string(date- time)
yyyy-mm-dd
faceImgUrl
头像图片
false
string
Jpg 格式，大小不超过
300Kb,钥匙柜和接口服务器均可访问此网络路径
fingerPrint
指纹特征值
false
string
指纹发卡器识别指纹特征
id
关键字
false
integer(int64)
isAsc
排序的方向
false
string
mobile
联系手机
true
string
参数名称
参数说明
请求类型
必须
数据类型
备注
name
姓名
true
string
orderByColumn
排序列
false
string
overdue
是否设置有效期
false
integer(int32)
设置有效期：0.设置有效期，1.永久有效
注：当值为 0 时，endTime必填
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
qrcode
人员二维码
false
string
remark
备注
false
string
searchValue
搜索值
false
string
staffGroupId
员工组
false
integer(int64)
state
状态
true
integer(int32)
状态：1.正常，2.停用
sysUserId
系统用户id
false
integer(int64)
type
类型
true
integer(int32)
类型：1.普通用户，2.授权用户，3.二次授权
uname
借换钥匙用户账号
false
string
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
upwd
借还钥匙用户密码
false
string
wxAvatarUrl
关联微信号头像
false
string
参数名称
参数说明
请求类型
必须
数据类型
备注
wxMiniOpenId
关联微信小程序
openid
false
string
wxMpOpenId
关联微信公众号
openid
false
string
wxNickName
关联微信号昵称
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{"code": 200,"msg": "操作成功", "data": null}
{
"code": 200,
"msg": "操作成功", "data": null
}
{
"code": 500,
"msg": "新增员工失败，手机号已存在", "data": null
}
2.7.2 修改员工
接口地址
PUT http://serverIp:port/prod-api/kms/staff
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"id":1,
"allowKeyAmount": 101,
"cardNo": "6435412631500",
"cascadeCreateUser": faıse,
"deptId":129,
"overdue": 0,
"endTime": "2023-06-22",
"faceImgUrl": "http://8.142.114.71:20000/headImg/33fdf07084cd4aab3e53be2c99529916.jpg
",
"mobile": "15912345670", "name": "张三 0",
"state": 1,
"type": 1,
"uname": "tdwy1", "upwd": "1231"
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
员工管理业务对象
员工管理业务对象
body
true
员工管理业务对象
员工管理业务对象
allowKeyAmount
可借取钥匙数量
true
integer(int64)
cardNo
卡号
true
string
发卡器识别 IC 卡号
cascadeCreateUser
是否级联创
建系统用户
false
boolean
固定值 false
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
True
integer(int64)
可设置固定值 129 （sys_dept 表 id）
endTime
有效期截止时间
false
string(date- time)
yyyy-mm-dd
faceImgUrl
头像图片
false
string
Jpg 格式，大小不超过
300Kb,钥匙柜和接口服务器均可访问此网络路径
fingerPrint
指纹特征值
false
string
指纹发卡器识别指纹特征
参数名称
参数说明
请求类型
必须
数据类型
备注
id
关键字
true
integer(int64)
员工 id
isAsc
排序的方向
false
string
mobile
联系手机
true
string
name
姓名
true
string
orderByColumn
排序列
false
string
overdue
是否设置有效期
false
integer(int32)
设置有效期：0.设置有效期，1.永久有效
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
qrcode
人员二维码
false
string
remark
备注
false
string
searchValue
搜索值
false
string
staffGroupId
员工组
false
integer(int64)
state
状态
true
integer(int32)
状态：1.正常，2.停用
sysUserId
系统用户id
false
integer(int64)
type
类型
true
integer(int32)
类型：1.普通用户，2.授权用户，3.二次授权
uname
借换钥匙用户账号
false
string
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
参数名称
参数说明
请求类型
必须
数据类型
备注
upwd
借还钥匙用户密码
false
string
wxAvatarUrl
关联微信号头像
false
string
wxMiniOpenId
关联微信小程序
openid
false
string
wxMpOpenId
关联微信公众号
openid
false
string
wxNickName
关联微信号昵称
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{"code": 200,
{
"code": 200,
"msg": "操作成功", "data": null
}
2.7.3 查询员工列表
接口地址
GET http://serverIp:port/prod-api/kms/staff/list
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
cardNo
卡号
query
true
string
name
姓名
query
true
string
state
状态
query
true
integer(int32)
type
类型
query
true
integer(int32)
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
员工管理视图对象
allowKeyAmount
可借取钥匙数量
integer(int64)
cardNo
卡号
string
cascadeCreateUser
是否级联创建系统用户
boolean
createBy
创建人
string
createTime
创建时间
string(date-time)
dept
SysDept
SysDept
ancestors
string
children
array
SysDept
参数名称
参数说明
类型
备注
createBy
string
createTime
string
delFlag
string
deptId
integer
deptName
string
email
string
leader
string
orderNum
string
params
object
parentId
integer
parentName
string
phone
string
status
string
updateBy
string
updateTime
string
deptId
部门
integer(int64)
endTime
有效期截止时间
string(date-time)
faceImgUrl
头像图片
string
fingerPrint
指纹特征值
string
id
关键字
integer(int64)
参数名称
参数说明
类型
备注
mobile
联系手机
string
name
姓名
string
overdue
是否设置有效期
integer(int32)
qrcode
人员二维码
string
remark
备注
string
staffGroup
员工组视图对象
员工组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
remark
备注
string
staffs
array
员工管理视图对象
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
staffGroupId
员工组
integer(int64)
state
状态
integer(int32)
sysUserId
系统用户 id
integer(int64)
topDeptId
integer(int64)
参数名称
参数说明
类型
备注
type
类型
integer(int32)
uname
借换钥匙用户账号
string
updateBy
修改人
string
updateTime
修改时间
string(date-time)
upwd
借还钥匙用户密码
string
wxAvatarUrl
关联微信号头像
string
wxMiniOpenId
关联微信小程序 openid
string
wxMpOpenId
关联微信公众号 openid
string
wxNickName
关联微信号昵称
string
total
总记录数
integer(int64)
integer(int64)
响应示例
{"total": 1,"rows": [ {"id": 1,
{
"total": 1,
"rows": [ {
"id": 1,
"name": "张三 0",
"cardNo": "6435412631500",
"fingerPrint": null,
"faceImgUrl": "http://8.142.114.71:20000/headImg/33fdf07084cd4aab3e53be2c99 529916.jpg",
"qrcode": null,
"mobile": "15912345670",
"allowKeyAmount": 101,
"type": 1,
"state": 1,
"deptId": 129,
"staffGroupId": null,
"remark": null,
"createBy": "tdwy",
"createTime": "2023-06-20 11:41:04",
"updateBy": "tdwy",
"updateTime": "2023-06-20 17:33:36",
"sysUserId": null,
"cascadeCreateUser": null,
"dept": {
"deptId": 129,
"parentId": null,
"ancestors": null,
"deptName": "天地伟业",
"orderNum": null, "leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null, "createBy": null,
"createTime": null, "updateBy": null,
"updateTime": null, "children": [],
"params": {}
},"staffGroup": { "id": 1,"groupName": null,"remark": null,"createBy": "tdwy","createTime": "2023-06-20 11:41:04", "updateBy": "tdwy","updateTime": "2023-06-20 17:33:36", "staffs": null,"type": null,"deptId": null },"uname": "tdwy1", "upwd": "1231",
},
"staffGroup": { "id": 1,
"groupName": null,
"remark": null,
"createBy": "tdwy",
"createTime": "2023-06-20 11:41:04", "updateBy": "tdwy",
"updateTime": "2023-06-20 17:33:36", "staffs": null,
"type": null,
"deptId": null },
"uname": "tdwy1", "upwd": "1231",
"overdue": 0,
"endTime": "2023-06-22 23:59:59",
"topDeptId": 129,
"wxMpOpenId": null,
"wxNickName": null,
"wxAvatarUrl": null,
"wxMiniOpenId": null }
],
"code": 200,
"msg": "查询成功" }
2.7.4 删除员工管理
接口地址
DELETE http://serverIp:port/prod-api/kms/staff/{ids}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
ids
ids
path
true
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": null
}
2.7.5 获取员工详细信息
接口地址
GET http://serverIp:port/prod-api/kms/staff/{id}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
id
id
path
true
integer(int64)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
员工管理视图对象
员工管理视图对象
allowKeyAmount
可借取钥匙数量
integer(int64)
cardNo
卡号
string
cascadeCreateUser
是否级联创建系统用户
boolean
createBy
创建人
string
createTime
创建时间
string(date-time)
dept
SysDept
SysDept
ancestors
string
children
array
SysDept
createBy
string
createTime
string
delFlag
string
deptId
integer
deptName
string
email
string
参数名称
参数说明
类型
备注
leader
string
orderNum
string
params
object
parentId
integer
parentName
string
phone
string
status
string
updateBy
string
updateTime
string
deptId
部门
integer(int64)
endTime
有效期截止时间
string(date-time)
faceImgUrl
头像图片
string
fingerPrint
指纹特征值
string
id
关键字
integer(int64)
mobile
联系手机
string
name
姓名
string
overdue
是否设置有效期
integer(int32)
qrcode
人员二维码
string
remark
备注
string
staffGroup
员工组视图对象
员工组视图对象
参数名称
参数说明
类型
备注
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
remark
备注
string
staffs
array
员工管理视图对象
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
staffGroupId
员工组
integer(int64)
state
状态
integer(int32)
sysUserId
系统用户 id
integer(int64)
topDeptId
integer(int64)
type
类型
integer(int32)
uname
借换钥匙用户账号
string
updateBy
修改人
string
updateTime
修改时间
string(date-time)
upwd
借还钥匙用户密码
string
wxAvatarUrl
关联微信号头像
string
参数名称
参数说明
类型
备注
wxMiniOpenId
关联微信小程序 openid
string
wxMpOpenId
关联微信公众号 openid
string
wxNickName
关联微信号昵称
string
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": {
"id": 1,
"name": "张三 0",
"cardNo": "6435412631500","fingerPrint": null,"faceImgUrl": "http://8.142.114.71:20000/headImg/33fdf07084cd4aab3e53be2c99529916.jpg","qrcode": null,"mobile": "15912345670","allowKeyAmount": 101,"type": 1,"state": 1,"deptId": 129,"staffGroupId": null,"remark": null,"createBy": "tdwy",
"cardNo": "6435412631500",
"fingerPrint": null,
"faceImgUrl": "http://8.142.114.71:20000/headImg/33fdf07084cd4aab3e53be2c995299
16.jpg",
"qrcode": null,
"mobile": "15912345670",
"allowKeyAmount": 101,
"type": 1,
"state": 1,
"deptId": 129,
"staffGroupId": null,
"remark": null,
"createBy": "tdwy",
"createTime": "2023-06-20 11:41:04", "updateBy": "tdwy",
"updateTime": "2023-06-20 17:33:36", "sysUserId": null,
"cascadeCreateUser": null,
"dept": null,
"staffGroup": null,
"uname": "tdwy1",
"upwd": "1231",
"overdue": 0,
"endTime": "2023-06-22 23:59:59", "topDeptId": null,
"wxMpOpenId": null,
"wxNickName": null,
"wxAvatarUrl": null,
"wxMiniOpenId": null }
}
2.9 Token 管理
2.9.1 获取 Token
接口地址
POST http://serverIp:port/prod-api/getToken
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"clientId": "tdwy",
"clientSecret": "123456" }
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
获取 Token
获取 Token
body
true
获取 Token
获取 Token
clientId
调用接口的用户名
true
string
参数名称
参数说明
请求类型
必须
数据类型
备注
clientSecret
调用接口的密钥
true
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
token
Token 值
string
msg
消息内容
string
响应示例
{"code": 200,"msg": "操作成功","data": {"token": "eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImZlNWFlMzY0LTQ3MDctNGQ3 Yi05ODMxLTY0MGFhMjE1Yzk5OSJ9.gBLtnoSWZWKvGumDL0Srkh8p9FXdv_jr4QWAYzwXOGAO3iagylhNanajsa ekRJDCMz9Q_4mjbKZGBv6vnmLAcQ"}
{
"code": 200,
"msg": "操作成功",
"data": {
"token": "eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImZlNWFlMzY0LTQ3MDctNGQ3 Yi05ODMxLTY0MGFhMjE1Yzk5OSJ9.gBLtnoSWZWKvGumDL0Srkh8p9FXdv_jr4QWAYzwXOGAO3iagylhNanajsa ekRJDCMz9Q_4mjbKZGBv6vnmLAcQ"
}
}
2.11 部门管理
2.11.1 根据用户 ID 获取部门信息
接口地址
GET http://serverIp:port/prod-api/system/dept/root/{userId}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
userId
用户 ID
path
true
integer(int64)
员工 id
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
deptId
部门 id
integer
parentId
父部门 id
integer
ancestors
祖级列表
string
deptName
部门名称
string
orderNum
显示顺序
integer
参数名称
参数说明
类型
备注
leader
负责人
string
phone
联系电话
string
email
邮箱
string
status
部门状态（0 正常 1 停用）
string
delFlag
删除标志（0 代表存在 2 代表删除）
string
createBy
创建者
string
createTime
创建时间
string(date-time)
updateBy
更新者
string
updateTime
更新时间
string(date-time)
msg
消息内容
string
响应示例
{"code": 200,"msg": "操作成功", "data": {"deptId": 129,"parentId": 100,
{
"code": 200,
"msg": "操作成功", "data": {
"deptId": 129,
"parentId": 100,
"ancestors": "0,100",
"deptName": "天地伟业",
"orderNum": "1",
"leader": null,
"phone": null,
"email": null,
"status": "0",
"delFlag": "0",
"parentName": null,
"createBy": "admin",
"createTime": "2023-06-19 17:31:28", "updateBy": null,
"updateTime": null,
"children": [],
"params": {} }
}
2.12 钥匙授权信息管理
2.12.1 获取钥匙授权信息详细信息
接口地址
GET http://serverIp:port/prod-
api/kms/permissioninfo/getByPermissionId/{uuid}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
uuid
uuid
path
true
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
array
uuid
全局唯一主键
string
permissionUuid
授权记录 ID
string
staffId
授权人 ID
string
staffName
授权人名称
string
permissionType
授权类型：2.一次授权，3.二次授权
string
type
类型：1.本地授权，2.远程授权
integer
state
状态：1.授权成功，2.授权失败
integer
参数名称
参数说明
类型
备注
permissionTime
授权时间
string(date-time)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": [ {
"uuid": "fbf90eb0-10b7-4dc2-8c41-d9a38535465a",
"permissionUuid": "b991ab8d-de07-4ede-9da7-f35123e34326", "staffId": 2300,
"staffName": "张三",
"permissionType": 2,
"type": 2,
"state": 1,
"permissionTime": "2023-06-21 14:37:07" }
]
}
2.14 钥匙管理
2.14.1 新增钥匙
接口地址
POST http://serverIp:port/prod-api/kms/opener 接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"cnName": "测试钥匙 1",
"cnNamePy": "测试钥匙 1", "code": "2",
"lockerId": 3,
"lockholeId": 1,
"number": "31241235123",
"remark": "备注",
"sort": 1,
"state": 3,
"type": 1,
"warnInterval": 24 }
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
钥匙管理业务对象
钥匙管理业务对象
body
true
钥匙管理业务对象
钥匙管理业务对象
cnName
钥匙名称
true
string
cnNamePy
钥匙名称拼音
false
string
code
锁柜编号
true
string
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
false
integer(int64)
detailImgUrl
钥匙详情图片路径
false
string
id
关键字
false
integer(int64)
isAsc
排序的方向
false
string
lockerId
锁柜名称
true
integer(int64)
lockholeId
锁芯 ID
true
integer(int64)
number
钥匙插销
true
string
openerGroupId
钥匙组 ID
false
integer(int64)
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
remark
备注
false
string
searchValue
搜索值
false
string
参数名称
参数说明
请求类型
必须
数据类型
备注
sort
锁芯序号
true
integer(int64)
state
状态
true
integer(int32)
状态：1.在柜，2.借出，3.录入，10.丢失
type
类型
true
integer(int32)
类型：1.无授权，2.一次授权，3.二次授权
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
warn
风险提示
false
string
warnInterval
警告间隔
true
integer(int64)
单位小时
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.14.2 修改钥匙
接口地址
PUT http://serverIp:port/prod-api/kms/opener接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"id": 2,
"cnName": "测试钥匙 21",
"cnNamePy": "测试钥匙 21", "code": "2",
"lockerId": 3,
"lockholeId": 2,
"number": "54231231311",
"remark": "备注 21", "sort": 2,
"state": 3,
"type": 1,
"warnInterval": 24
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
钥匙管理业务对象
钥匙管理业务对象
body
true
钥匙管理业务对象
钥匙管理业务对象
cnName
钥匙名称
true
string
cnNamePy
钥匙名称拼音
false
string
code
锁柜编号
true
string
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
false
integer(int64)
detailImgUrl
钥匙详情图片路径
false
string
id
关键字
True
integer(int64)
isAsc
排序的方向
false
string
lockerId
锁柜名称
true
integer(int64)
lockholeId
锁芯 ID
true
integer(int64)
number
钥匙插销
true
string
参数名称
参数说明
请求类型
必须
数据类型
备注
openerGroupId
钥匙组 ID
false
integer(int64)
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
remark
备注
false
string
searchValue
搜索值
false
string
sort
锁芯序号
true
integer(int64)
state
状态
true
integer(int32)
状态：1.在柜，2.借出，3.录入，10.丢失
type
类型
true
integer(int32)
类型：1.无授权，2.一次授权，3.二次授权
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
warn
风险提示
false
string
warnInterval
警告间隔
true
integer(int64)
单位小时
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": null
}
2.14.4 查询钥匙列表
接口地址
GET http://serverIp:port/prod-api/kms/opener/list接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
cnName
钥匙名称
query
true
string
lockerId
锁柜 id
query
true
integer(int64)
number
钥匙插销
query
true
string
state
状态
query
true
integer(int32)
openerGroupId
钥匙组 ID
query
false
integer(int64)
type
类型
query
true
integer(int32)
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
参数名称
参数说明
类型
备注
msg
消息内容
string
rows
列表数据
array
钥匙管理视图对象
backStaffName
string
backTime
string(date-time)
borrowTime
string(date-time)
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string(date-time)
deptId
integer(int64)
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer(int64)
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
参数名称
参数说明
类型
备注
name
锁柜名称
string
openers
array
钥匙管理视图对象
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer(int64)
lockhole
锁芯管理视图对象
锁芯管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
id
关键字
integer
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
参数名称
参数说明
类型
备注
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer
opener
钥匙管理视图对象
钥匙管理视图对象
remark
备注
string
sort
序号
integer
state
锁芯状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockholeId
锁芯 ID
integer(int64)
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
参数名称
参数说明
类型
备注
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer(int64)
remark
备注
string
sort
锁芯序号
integer(int64)
state
状态
integer(int32)
type
类型
integer(int32)
updateBy
修改人
string
updateTime
修改时间
string(date-time)
warn
风险提示
string
warnInterval
警告间隔
integer(int64)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 2,
"rows": [ {
"id": 1,
"lockerId": 3,
"code": "2",
"lockholeId": 1,
"sort": 1,
"openerGroupId": null,
"cnName": "测试钥匙 1",
"cnNamePy": "测试钥匙 1", "number": "31241235123", "type": 1,
"state": 3,
"warnInterval": 24, "remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49",
"locker": {
"id": 1,
"code": "2",
"name": "测试柜 2",
"state": 3,
"remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49", "openers": null,
"deptId": null },
"lockhole": {
"id": 1,"lockerId": 3, "code": "2","sort": 1,"state": 3,"remark": "备注","createBy": "tdwy","createTime": "2023-06-21 13:02:49", "updateBy": "tdwy","updateTime": "2023-06-21 13:02:49","locker": {"id": 1,"code": "2","name": "测试柜 2","state": 3,
"id": 1,
"lockerId": 3, "code": "2",
"sort": 1,
"state": 3,
"remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49",
"locker": {
"id": 1,
"code": "2",
"name": "测试柜 2",
"state": 3,
"remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49", "openers": null,
"deptId": null },
"opener": null
},
"openerGroup": {
"id": 1,
"groupName": null, "remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49", "openers": null,
"deptId": null },
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
},
{
"id": 2,
"lockerId": 3,
"code": "2",
"lockholeId": 2,
"sort": 2,
"openerGroupId": null, "cnName": "测试钥匙 21",
"cnNamePy": "测试钥匙 21","number": "54231231311","type": 1,"state": 3,"warnInterval": 24,"remark": "备注 21","createBy": "tdwy","createTime": "2023-06-21 13:05:10", "updateBy": "tdwy","updateTime": "2023-06-21 13:08:54","locker": {"id": 2,"code": "2","name": "测试柜 2","state": 3,
"cnNamePy": "测试钥匙 21",
"number": "54231231311",
"type": 1,
"state": 3,
"warnInterval": 24,
"remark": "备注 21",
"createBy": "tdwy",
"createTime": "2023-06-21 13:05:10", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:08:54",
"locker": {
"id": 2,
"code": "2",
"name": "测试柜 2",
"state": 3,
"remark": "备注 21",
"createBy": "tdwy",
"createTime": "2023-06-21 13:05:10", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:08:54", "openers": null,
"deptId": null },
"lockhole": {
"id": 2,
"lockerId": 3, "code": "2",
"sort": 2,
"state": 3,
"remark": "备注 21",
"createBy": "tdwy",
"createTime": "2023-06-21 13:05:10", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:08:54",
"locker": {
"id": 2,
"code": "2",
"name": "测试柜 2",
"state": 3,
"remark": "备注 21",
"createBy": "tdwy",
"createTime": "2023-06-21 13:05:10", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:08:54", "openers": null,
"deptId": null },
"opener": null
},
"openerGroup": {
"id": 2,
"groupName": null,
"remark": "备注 21","createBy": "tdwy","createTime": "2023-06-21 13:05:10", "updateBy": "tdwy","updateTime": "2023-06-21 13:08:54", "openers": null,"deptId": null},"warn": null,"detailImgUrl": null, "deptId": null,"lendStaffName": null, "borrowTime": null,"backStaffName": null, "backTime": null
"remark": "备注 21",
"createBy": "tdwy",
"createTime": "2023-06-21 13:05:10", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:08:54", "openers": null,
"deptId": null
},
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
],
"code": 200,
"msg": "查询成功" }
2.14.5 查询可借钥匙
接口地址
GET http://serverIp:port/prod-api/kms/opener/selectCanBorrow接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
userId
userId
query
true
integer(int64)
pageNum
pageNum
query
true
integer(int32)
pageSize
pageSize
query
true
integer(int32)
openerName
openerName
query
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
CanBorrowOpener
cnName
string
cnNamePy
string
lockerName
string
lockholeSort
integer(int32)
openerId
string
staffName
string
state
integer(int32)
type
integer(int32)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"code": 0,
"msg": "",
"rows": [ {
"cnName": "",
"cnNamePy": "",
"lockerName": "", "lockholeSort": 0, "openerId": "",
"staffName": "", "state": 0,
"type": 0
}
],
"total": 0
}
2.14.6 查询可借钥匙员工列表
接口地址
GET http://serverIp:port/prod-api/kms/opener/staff接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
id
关键字
query
false
integer(int64)
响应状态
响应参数参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
参数名称
参数说明
类型
备注
msg
消息内容
string
rows
列表数据
array
员工管理视图对象
allowKeyAmount
可借取钥匙数量
integer(int64)
cardNo
卡号
string
cascadeCreateUser
是否级联创建系统用户
boolean
createBy
创建人
string
createTime
创建时间
string(date-time)
dept
SysDept
SysDept
ancestors
string
children
array
SysDept
createBy
string
createTime
string
delFlag
string
deptId
integer
deptName
string
email
string
leader
string
orderNum
string
params
object
parentId
integer
参数名称
参数说明
类型
备注
parentName
string
phone
string
status
string
updateBy
string
updateTime
string
deptId
部门
integer(int64)
endTime
有效期截止时间
string(date-time)
faceImgUrl
头像图片
string
fingerPrint
指纹特征值
string
id
关键字
integer(int64)
mobile
联系手机
string
name
姓名
string
overdue
是否设置有效期
integer(int32)
qrcode
人员二维码
string
remark
备注
string
staffGroup
员工组视图对象
员工组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
参数名称
参数说明
类型
备注
id
关键字
integer
remark
备注
string
staffs
array
员工管理视图对象
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
staffGroupId
员工组
integer(int64)
state
状态
integer(int32)
sysUserId
系统用户 id
integer(int64)
topDeptId
integer(int64)
type
类型
integer(int32)
uname
借换钥匙用户账号
string
updateBy
修改人
string
updateTime
修改时间
string(date-time)
upwd
借还钥匙用户密码
string
wxAvatarUrl
关联微信号头像
string
wxMiniOpenId
关联微信小程序 openid
string
wxMpOpenId
关联微信公众号 openid
string
wxNickName
关联微信号昵称
string
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 1,
"rows": [ {
"id": 3,
"name": "张三 22",
"cardNo": "64354312631523", "fingerPrint": null,
"faceImgUrl": null,
"qrcode": null,
"mobile": "15912345644", "allowKeyAmount": 100,
"type": 1,
"state": 1,
"deptId": 129,
"staffGroupId": null, "remark": null,
"createBy": "tdwy",
"createTime": "2023-06-21 13:22:36","updateBy": "tdwy","updateTime": "2023-06-21 13:22:36", "sysUserId": null,"cascadeCreateUser": null, "dept": {"deptId": 129,"parentId": null,"ancestors": null,"deptName": "天地伟业","orderNum": null,"leader": null,"phone": null,"email": null,"status": null,
"createTime": "2023-06-21 13:22:36",
"updateBy": "tdwy",
"updateTime": "2023-06-21 13:22:36", "sysUserId": null,
"cascadeCreateUser": null, "dept": {
"deptId": 129,
"parentId": null,
"ancestors": null,
"deptName": "天地伟业",
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"children": [],
"params": {} },
"staffGroup": {
"id": 3,
"groupName": null,
"remark": null,
"createBy": "tdwy",
"createTime": "2023-06-21 13:22:36", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:22:36", "staffs": null,
"type": null,
"deptId": null },
"uname": null,
"upwd": null,
"overdue": null,
"endTime": null,
"topDeptId": null,
"wxMpOpenId": null,
"wxNickName": null,
"wxAvatarUrl": null,
"wxMiniOpenId": null }
],
"code": 200,
"msg": "查询成功" }
2.14.7 删除钥匙管理
接口地址
DELETE http://serverIp:port/prod-api/kms/opener/{ids}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
ids
ids
path
true
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": null
}
2.14.8 获取钥匙详细信息
接口地址
GET http://serverIp:port/prod-api/kms/opener/{id}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
id
id
path
true
integer(int64)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
钥匙管理视图对象
钥匙管理视图对象
backStaffName
string
backTime
string(date-time)
borrowTime
string(date-time)
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
参数名称
参数说明
类型
备注
createBy
创建人
string
createTime
创建时间
string(date-time)
deptId
integer(int64)
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer(int64)
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer(int64)
lockhole
锁芯管理视图对象
锁芯管理视图对象
参数名称
参数说明
类型
备注
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
id
关键字
integer
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer
opener
钥匙管理视图对象
钥匙管理视图对象
remark
备注
string
sort
序号
integer
参数名称
参数说明
类型
备注
state
锁芯状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockholeId
锁芯 ID
integer(int64)
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer(int64)
remark
备注
string
sort
锁芯序号
integer(int64)
state
状态
integer(int32)
type
类型
integer(int32)
参数名称
参数说明
类型
备注
updateBy
修改人
string
updateTime
修改时间
string(date-time)
warn
风险提示
string
warnInterval
警告间隔
integer(int64)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": {
"id": 1,
"lockerId": 3,
"code": "2",
"lockholeId": 1,
"sort": 1,
"openerGroupId": null,
"cnName": "测试钥匙 1",
"cnNamePy": "测试钥匙 1", "number": "31241235123", "type": 1,
"state": 3,
"warnInterval": 24, "remark": "备注",
"createBy": "tdwy",
"createTime": "2023-06-21 13:02:49", "updateBy": "tdwy",
"updateTime": "2023-06-21 13:02:49", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null,
"deptId": 129,
"lendStaffName": null,
"borrowTime": null,
"backStaffName": null,
"backTime": null }
}
2.16 锁柜管理
2.16.1 新增锁柜
接口地址
POST http://serverIp:port/prod-api/kms/locker
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"code": "1",
"name": "测试柜 1", "remark": "备注", "state":1
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
锁柜管理业务对象
锁柜管理业务对象
body
true
锁柜管理业务对象
锁柜管理业务对象
code
锁柜编号
true
string
不允许重复
参数名称
参数说明
请求类型
必须
数据类型
备注
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
false
integer(int64)
id
关键字
false
integer(int64)
isAsc
排序的方向
false
string
name
锁柜名称
true
string
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
remark
备注
false
string
searchValue
搜索值
false
string
state
状态
true
integer(int32)
状态：1.离线，2.正常， 10.停用，20.故障
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.16.2 修改锁柜
接口地址
PUT http://serverIp:port/prod-api/kms/locker
接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{"id":3,"code": "2","name": "测试柜 2", "remark": "备注 2", "state":2}
{
"id":3,
"code": "2",
"name": "测试柜 2", "remark": "备注 2", "state":2
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
锁柜管理业务对象
锁柜管理业务对象
body
true
锁柜管理业务对象
锁柜管理业务对象
code
锁柜编号
true
string
不允许重复
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
false
integer(int64)
id
关键字
True
integer(int64)
isAsc
排序的方向
false
string
name
锁柜名称
true
string
参数名称
参数说明
请求类型
必须
数据类型
备注
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
remark
备注
false
string
searchValue
搜索值
false
string
state
状态
true
integer(int32)
状态：1.离线，2.正常， 10.停用，20.故障
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.16.3 查询锁柜列表
接口地址
GET http://serverIp:port/prod-api/kms/locker/list接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
name
锁柜名称
query
true
string
state
状态
query
true
integer(int32)
pageNum
当前页数
query
false
integer(int32)
pageNum
pageSize
分页大小
query
false
integer(int32)
pageSize
响应状态
响应参数参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string(date-time)
deptId
integer(int64)
id
关键字
integer(int64)
name
锁柜名称
string
openers
array
钥匙管理视图对象
backStaffName
string
参数名称
参数说明
类型
备注
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
lockhole
锁芯管理视图对象
锁芯管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
id
关键字
integer
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
参数名称
参数说明
类型
备注
opener
钥匙管理视图对象
钥匙管理视图对象
remark
备注
string
sort
序号
integer
state
锁芯状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
remark
备注
string
参数名称
参数说明
类型
备注
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
state
状态
integer(int32)
updateBy
修改人
string
updateTime
修改时间
string(date-time)
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 1,
"rows": [ {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": 2,
"remark": "备注 2",
"createBy": "tdwy",
"createTime": "2023-06-21 09:19:56", "updateBy": "tdwy",
"updateTime": "2023-06-21 09:27:14", "openers": null,
"deptId": 129
}
],
"code": 200,
"msg": "查询成功"
}
2.16.4 删除锁柜
接口地址
DELETE http://serverIp:port/prod-api/kms/locker/{ids}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
ids
ids
path
true
string
锁柜 id
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.16.5 获取锁柜详细信息
接口地址
GET http://serverIp:port/prod-api/kms/locker/{id}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
id
id
path
true
integer(int64)
响应状态
响应参数参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string(date-time)
deptId
integer(int64)
id
关键字
integer(int64)
name
锁柜名称
string
openers
array
钥匙管理视图对象
backStaffName
string
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
参数名称
参数说明
类型
备注
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
lockhole
锁芯管理视图对象
锁芯管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
id
关键字
integer
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
opener
钥匙管理视图对象
钥匙管理视图对象
remark
备注
string
sort
序号
integer
state
锁芯状态
integer
参数名称
参数说明
类型
备注
updateBy
修改人
string
updateTime
修改时间
string
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
remark
备注
string
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
参数名称
参数说明
类型
备注
updateTime
修改时间
string
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
state
状态
integer(int32)
updateBy
修改人
string
updateTime
修改时间
string(date-time)
msg
消息内容
string
响应示例
{"code": 200,"msg": "操作成功", "data": {"id": 3,"code": "2","name": "测试柜 2", "state": 2,
{
"code": 200,
"msg": "操作成功", "data": {
"id": 3,
"code": "2",
"name": "测试柜 2", "state": 2,
"remark": "备注 2",
"createBy": "tdwy",
"createTime": "2023-06-21 09:19:56", "updateBy": "tdwy",
"updateTime": "2023-06-21 09:27:14", "openers": null,
"deptId": 129
}
}
2.16.6 首页统计图
接口地址
GET http://serverIp:port/prod-api/kms/locker/statistics
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
id
id
integer(int64)
code
锁柜编号
string
name
锁柜名称
string
state
状态
integer(int32)
状态：1.离线，2.正常，10.停用，20.故障
remark
备注
string
inNum
在柜数量
integer
outNum
借出数量
integer
lostNum
丢失数量
integer
inputNum
录入数量
integer
noInputNum
未录入数量
integer
num
总数
integer
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功", "data": [
{
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": "2",
"remark": "备注 2",
"createTime": "2023-06-21 09:19:56",
"updateTime": "2023-06-21 09:27:14", "inNum": 0,
"outNum": 0,
"inputNum": 1,
"lostNum": 0,
"num": 10,
"noInputNum": 9
}
]
}
2.17 锁芯管理
2.17.1 修改锁芯
接口地址
PUT http://serverIp:port/prod-api/kms/lockhole接口描述
请求数据类型
application/json
响应数据类型
*/*
请求示例
{
"id": 1,
"lockerId":3,
"code":"2",
"remark": "123123122",
"sort": 1,
"state": 1
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
锁芯管理业务对象
锁芯管理业务对象
body
true
锁芯管理业务对象
锁芯管理业务对象
id
关键字
True
integer(int64)
code
锁柜编号
true
string
lockerId
锁柜 id
true
integer(int64)
remark
备注
false
string
sort
序号
true
integer(int64)
锁芯序号
state
锁芯状态
true
integer(int32)
状态：1.正常，10.停用， 20.故障
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": null }
2.17.2 查询锁芯列表
接口地址
GET http://serverIp:port/prod-api/kms/lockhole/list接口描述
智能钥匙管理系统 软件接口说明书
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
state
锁芯状态
query
true
integer(int32)
pageNum
当前页数
query
false
integer(int32)
pageSize
分页大小
query
false
integer(int32)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
rows
列表数据
array
锁芯管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string(date-time)
id
关键字
integer(int64)
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
参数名称
参数说明
类型
备注
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
backStaffName
string
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
参数名称
参数说明
类型
备注
lockhole
锁芯管理视图对象
锁芯管理视图对象
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
remark
备注
string
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
参数名称
参数说明
类型
备注
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer(int64)
opener
钥匙管理视图对象
钥匙管理视图对象
backStaffName
string
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
参数名称
参数说明
类型
备注
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer
lockhole
锁芯管理视图对象
锁芯管理视图对象
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
参数名称
参数说明
类型
备注
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
remark
备注
string
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
sort
序号
integer(int64)
state
锁芯状态
integer(int32)
updateBy
修改人
string
updateTime
修改时间
string(date-time)
参数名称
参数说明
类型
备注
total
总记录数
integer(int64)
integer(int64)
响应示例
{
"total": 10,
"rows": [ {
"id": 1,
"lockerId": 3,
"code": "2",
"sort": 1,
"state": 1,
"remark": "123123122", "createBy": null,
"createTime": "2023-06-21 09:58:18","updateBy": "tdwy","updateTime": "2023-06-21 10:29:54", "locker": {"id": 3,"code": "2","name": "测试柜 2","state": null,"remark": null,"createBy": null,"createTime": "2023-06-21 09:58:18", "updateBy": "tdwy","updateTime": "2023-06-21 10:29:54", "openers": null,
"createTime": "2023-06-21 09:58:18",
"updateBy": "tdwy",
"updateTime": "2023-06-21 10:29:54", "locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": "tdwy",
"updateTime": "2023-06-21 10:29:54", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 1,
"sort": 1,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": "tdwy",
"updateTime": "2023-06-21 10:29:54", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null,
"deptId": null,
"lendStaffName": null,
"borrowTime": null,
"backStaffName": null,
"backTime": null }
},
{
"id": 2,
"lockerId": 3,
"code": "2",
"sort": 2,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 2,
"sort": 2,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null,
"deptId": null,
"lendStaffName": null,
"borrowTime": null,
"backStaffName": null,
"backTime": null }
},
{
"id": 3,
"lockerId": 3,
"code": "2","sort": 3,"state": 1,"remark": null,"createBy": null,"createTime": "2023-06-21 09:58:18", "updateBy": null,"updateTime": "2023-06-21 09:58:18","locker": {"id": 3,"code": "2","name": "测试柜 2","state": null,"remark": null,"createBy": null,
"code": "2",
"sort": 3,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 3,
"sort": 3,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
},
{
"id": 4,
"lockerId": 3,
"code": "2",
"sort": 4,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 4,
"sort": 4,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null,
"deptId": null,
"lendStaffName": null,
"borrowTime": null,
"backStaffName": null,
"backTime": null }
},{"id": 5,"lockerId": 3,"code": "2","sort": 5,"state": 1,"remark": null,"createBy": null,"createTime": "2023-06-21 09:58:18", "updateBy": null,"updateTime": "2023-06-21 09:58:18","locker": {"id": 3,"code": "2",
},
{
"id": 5,
"lockerId": 3,
"code": "2",
"sort": 5,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 5,
"sort": 5,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}},{"id": 6,"lockerId": 3,"code": "2","sort": 6,"state": 1,"remark": null,"createBy": null,"createTime": "2023-06-21 09:58:18", "updateBy": null,"updateTime": "2023-06-21 09:58:18", "locker": {
}
},
{
"id": 6,
"lockerId": 3,
"code": "2",
"sort": 6,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 6,
"sort": 6,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null,
"borrowTime": null,"backStaffName": null,"backTime": null }},{"id": 7,"lockerId": 3,"code": "2","sort": 7,"state": 1,"remark": null,"createBy": null,"createTime": "2023-06-21 09:58:18", "updateBy": null,
"borrowTime": null,
"backStaffName": null,
"backTime": null }
},
{
"id": 7,
"lockerId": 3,
"code": "2",
"sort": 7,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 7,
"sort": 7,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null, "warn": null,
"detailImgUrl": null,
"deptId": null,"lendStaffName": null, "borrowTime": null,"backStaffName": null, "backTime": null}},{"id": 8,"lockerId": 3,"code": "2","sort": 8,"state": 1,"remark": null,"createBy": null,
"deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
},
{
"id": 8,
"lockerId": 3,
"code": "2",
"sort": 8,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 8,
"sort": 8,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,"detailImgUrl": null, "deptId": null,"lendStaffName": null, "borrowTime": null,"backStaffName": null, "backTime": null}},{"id": 9,"lockerId": 3,"code": "2","sort": 9,"state": 1,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
},
{
"id": 9,
"lockerId": 3,
"code": "2",
"sort": 9,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null },
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 9,
"sort": 9,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"lockhole": null,"openerGroup": null,"warn": null,"detailImgUrl": null, "deptId": null,"lendStaffName": null, "borrowTime": null,"backStaffName": null, "backTime": null}},{"id": 10,"lockerId": 3,"code": "2",
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
},
{
"id": 10,
"lockerId": 3,
"code": "2",
"sort": 10,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": {
"id": 3,
"code": "2",
"name": "测试柜 2",
"state": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "openers": null,
"deptId": null
},
"opener": {
"id": null,
"lockerId": 3,
"code": "2",
"lockholeId": 10,
"sort": 10,
"openerGroupId": null,
"cnName": null,
"cnNamePy": null,
"number": null,
"type": null,
"state": null,
"warnInterval": null,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18",
"locker": null,"lockhole": null,"openerGroup": null,"warn": null,"detailImgUrl": null, "deptId": null,"lendStaffName": null, "borrowTime": null,"backStaffName": null, "backTime": null}}],"code": 200,
"locker": null,
"lockhole": null,
"openerGroup": null,
"warn": null,
"detailImgUrl": null, "deptId": null,
"lendStaffName": null, "borrowTime": null,
"backStaffName": null, "backTime": null
}
}
],
"code": 200,
"msg": "查询成功" }
2.17.3 删除锁芯
接口地址
DELETE http://serverIp:port/prod-api/kms/lockhole/{ids}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
ids
ids
path
true
string
锁芯 id
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{"code": 200,"msg": "操作成功", "data": null}
{
"code": 200,
"msg": "操作成功", "data": null
}
2.17.4 获取锁芯详细信息
接口地址
GET http://serverIp:port/prod-api/kms/lockhole/{id}接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
id
id
path
true
integer(int64)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
锁芯管理视图对象
锁芯管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string(date-time)
id
关键字
integer(int64)
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
openers
array
钥匙管理视图对象
backStaffName
string
参数名称
参数说明
类型
备注
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
lockerId
锁柜 ID
integer
lockhole
锁芯管理视图对象
锁芯管理视图对象
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
参数名称
参数说明
类型
备注
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
remark
备注
string
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer(int64)
参数名称
参数说明
类型
备注
opener
钥匙管理视图对象
钥匙管理视图对象
backStaffName
string
backTime
string
borrowTime
string
cnName
钥匙名称
string
cnNamePy
钥匙名称拼音
string
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
detailImgUrl
钥匙详情图片路径
string
id
关键字
integer
lendStaffName
string
locker
锁柜管理视图对象
锁柜管理视图对象
code
锁柜编号
string
createBy
创建人
string
createTime
创建时间
string
deptId
integer
id
关键字
integer
name
锁柜名称
string
参数名称
参数说明
类型
备注
openers
array
钥匙管理视图对象
remark
备注
string
state
状态
integer
updateBy
修改人
string
updateTime
修改时间
string
lockerId
锁柜 ID
integer
lockhole
锁芯管理视图对象
锁芯管理视图对象
lockholeId
锁芯 ID
integer
number
钥匙插销
string
openerGroup
钥匙组视图对象
钥匙组视图对象
createBy
创建人
string
createTime
创建时间
string
deptId
integer
groupName
组名
string
id
关键字
integer
openers
array
钥匙管理视图对象
remark
备注
string
updateBy
修改人
string
updateTime
修改时间
string
openerGroupId
钥匙组 ID
integer
参数名称
参数说明
类型
备注
remark
备注
string
sort
锁芯序号
integer
state
状态
integer
type
类型
integer
updateBy
修改人
string
updateTime
修改时间
string
warn
风险提示
string
warnInterval
警告间隔
integer
remark
备注
string
sort
序号
integer(int64)
state
锁芯状态
integer(int32)
updateBy
修改人
string
updateTime
修改时间
string(date-time)
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": {
"id": 2,
"lockerId": 3,
"code": "2",
"sort": 2,
"state": 1,
"remark": null,
"createBy": null,
"createTime": "2023-06-21 09:58:18", "updateBy": null,
"updateTime": "2023-06-21 09:58:18", "locker": null,
"opener": null }
}
2.18 开放接口
2.18.1 心跳接口
接口地址
GET http://serverIp:port/prod-api/heartBeat接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
暂无
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "心跳响应成功",
}
"data": null
2.18.2 批量删除员工
接口地址
POST http://serverIp:port/prod-api/batchDeleteStaff接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
["11111111111111111117","22222222222222222228","222222222222222222281"]
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
strings
string
body
true
array
第三方员工 id
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
msg
消息内容
string
响应示例
{
"code": 500,
"msg": "操作失败，未查询到需要删除的人员信息",
"data": null
}
2.18.3 批量同步员工
接口地址
POST http://serverIp:port/prod-api/batchSyncStaff接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
[{
"allowKeyAmount": 10, "cardNo": "11119",
"deptId":129, "overdue": 0,
"endTime": "2023-07-19",
"faceImgUrl": "http://192.168.0.35/headImg/a2b1e77e9ffb196f7e8b6c4a5b8b5eb9. jpg",
"cascadeCreateUser": true,
"mobile": "14911111115",
"account":"1689774692469t0009",
"name": "张三 19",
"state": 1,
"type": 1,
"uname": "zx18723439",
"upwd": "435434432129",
"role":2,
"personnelId": "11111111111111111119"
},{
"allowKeyAmount": 28,
"cardNo": "2222228", "deptId":129, "overdue": 1, "faceImgUrl": "http://192.168.0.35/headImg/a2b1e77e9ffb196f7e8b6c4a5b8b5eb9.
jpg",
"cascadeCreateUser": true, "mobile": "14911123116", "account":"1689774692469t0001", "name": "李四 18", "state": 1, "type": 2, "uname": "zx287654wr8",
"upwd": "6434313828",
"role":1,
"personnelId": "22222222222222222228"
},{
"allowKeyAmount": 1,
"cardNo": "22222281",
"deptId":129,
"overdue": 1,
"faceImgUrl": "http://192.168.0.35/headImg/a2b1e339ffb196f7e8b6c4a5b8b5eb9.j
pg",
"cascadeCreateUser": true,
"mobile": "14911123111",
"account":"1689774692469t0002", "name": "李四 181",
"state": 1, "type": 2,
"uname": "zx287654wr81",
"upwd": "64343138281",
"role":1,
"personnelId": "222222222222222222281"
},{
"allowKeyAmount": 17,
"cardNo": "22227781",
"deptId":129,
"overdue": 1,
"faceImgUrl": "http://192.168.0.35/headImg/a2b1e77e9ffb196f7e8b6c4a5b8b5eb9.
jpg",
"cascadeCreateUser": true,
"mobile": "15912345644",
"account":"1689774692469t0003", "name": "李四 187",
"state": 1,
"type": 2,"uname": "zx287654wr817","upwd": "643431382817","role":1,"personnelId": "2222222222222222222817"}]
"type": 2,
"uname": "zx287654wr817",
"upwd": "643431382817",
"role":1,
"personnelId": "2222222222222222222817"
}]
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
员工管理业务对象 s
员工管理业务对象
body
true
array
员工管理业务对象
allowKeyAmount
可借取钥匙数量
true
integer(int64)
cardNo
卡号
true
string<=50
发卡器识别 IC 卡号
cascadeCreateUser
是否级联创
建系统用户
true
boolean
固定值:true
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门ID
true
integer(int64)
可设置固定值 129 （sys_dept 表 id）
endTime
有效期截止时间
false
string(date- time)
参数名称
参数说明
请求类型
必须
数据类型
schema
faceImgUrl
头像图片
false
string
Jpg 格式，大小不超过
300Kb,钥匙柜和接口服务器均可访问此网络路径
fingerPrint
指纹特征值
false
string
指纹发卡器识别指纹特征
id
关键字
false
integer(int64)
isAsc
排序的方向
false
string
mobile
联系手机
true
string
account
第三方对接
系统登录账号
true
string
长度<=50,不允许重复
name
姓名
true
string
orderByColumn
排序列
false
string
overdue
是否设置有效期
false
integer(int32)
设置有效期：0.设置有效期，1.永久有效
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
personnelId
第三方对接系统人员
id
true
string
调用方人员 id
qrcode
人员二维码
false
string
remark
备注
false
string
role
第三方对接系统人员角色
false
integer(int32)
0：普通用户 (仅允许查询或授权钥匙操作，不能修改任
何配置)
1：高级管理员 (该角色允许配置柜子、钥匙、人员等信息)、
searchValue
搜索值
false
string
参数名称
参数说明
请求类型
必须
数据类型
schema
staffGroupId
员工组
false
integer(int64)
state
状态
true
integer(int32)
状态：1.正常，2.停用
sysUserId
系统用户id
false
integer(int64)
type
类型
true
integer(int32)
类型：1.普通用户，2.授权用户，3.二次授权
uname
借换钥匙用户账号
false
string,<=20
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
upwd
借还钥匙用户密码
false
string,<=100
wxAvatarUrl
关联微信号头像
false
string
wxMiniOpenId
关联微信小程序
openid
false
string
wxMpOpenId
关联微信公众号
openid
false
string
wxNickName
关联微信号昵称
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "人员数据同步成功【3】条，数据如下：1、姓名【张三 19】添加成功 2、姓名【李四 18】添加成功 3、姓名【李四 181】添加成功 ;人员数据同步失败【1】条,错误如下：1、姓名【李四 187】:手机号为空;",
"data": {
"failureList": [
"2222222222222222222817"
],
"successList": [
"11111111111111111119",
"22222222222222222228",
"222222222222222222281"
]
}
}
2.18.4 查询钥匙柜中所有钥匙信息
接口地址
POST http://serverIp:port/prod-api/getOpenerList
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
"cnName": "",
"cnNamePy": "",
"code": "",
"createBy": "",
"createTime": "",
"deptId": 0,
"detailImgUrl": "", "id": 0,
"isAsc": "asc,desc", "lockerId": 0,
"lockholeId": 0,
"number": "",
"openerGroupId": 0,
"orderByColumn": "", "pageNum": 0,
"pageSize": 0,
"params": {},
"remark": "",
"searchValue": "",
"sort": 0,
"state": 0, "type": 0,
"updateBy": "",
"updateTime": "",
"warn": "",
"warnInterval": 0
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
钥匙管理业务对象
钥匙管理业务对象
body
true
钥匙管理业务对象
钥匙管理业务对象
cnName
钥匙名称
true
string
cnNamePy
钥匙名称拼音
false
string
code
锁柜编号
true
string
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门 ID
false
integer(int64)
detailImgUrl
钥匙详情图片路径
false
string
id
关键字
false
integer(int64)
isAsc
排序的方向
false
string
lockerId
锁柜名称
true
integer(int64)
lockholeId
锁芯 ID
true
integer(int64)
number
钥匙插销
true
string
openerGroupId
钥匙组 ID
false
integer(int64)
参数名称
参数说明
请求类型
必须
数据类型
schema
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
remark
备注
false
string
searchValue
搜索值
false
string
sort
锁芯序号
true
integer(int64)
state
状态
true
integer(int32)
type
类型
true
integer(int32)
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
warn
风险提示
false
string
warnInterval
警告间隔
true
integer(int64)
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
msg
消息内容
string
响应示例
{
"code": 0,
}
"data": {},
"msg": ""
2.18.5 查询授权记录列表接口
接口地址
POST http://serverIp:port/prod-api/getPermissionList
接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{"applyTime": "","backStaffId": 0,"backStaffName": "", "backTime": "","beginApplyTime": "", "borrowTime": "","createBy": "","createTime": "","deptId": 0,"endApplyTime": "", "isAsc": "asc,desc", "lendStaffId": 0,
{
"applyTime": "",
"backStaffId": 0,
"backStaffName": "", "backTime": "",
"beginApplyTime": "", "borrowTime": "",
"createBy": "",
"createTime": "",
"deptId": 0,
"endApplyTime": "", "isAsc": "asc,desc", "lendStaffId": 0,
"lendStaffName": "", "lockerName": "",
"lockholeSort": 0,
"openerCnName": "", "openerId": 0,
"openerState": 0,
"openerType": 0,
"orderByColumn": "", "pageNum": 0,
"pageSize": 0,
"params": {},
"permissionState": 0, "remark": "",
"searchValue": "", "updateBy": "",
"updateTime": "",
"uuid": ""
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
借还&授权记录业务对象
借还&授权记录业务对象
body
true
借还&授权记录业务对象
借还&授权
记录业务对象
applyTime
申请时间
false
string(date- time)
backStaffId
归还员工 ID
true
integer(int64)
backStaffName
归还员工名称
true
string
backTime
归还时间
false
string(date- time)
beginApplyTime
申请时间起始日期：
YYYY-MM-DD HH:mm:ss
false
string
borrowTime
借出时间
false
string(date- time)
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门 ID
false
integer(int64)
endApplyTime
申请时间结束日期：
YYYY-MM-DD HH:mm:ss
false
string
isAsc
排序的方向
false
string
lendStaffId
借出员工 ID
true
integer(int64)
lendStaffName
借出员工名称
true
string
lockerName
锁柜名称
true
string
lockholeSort
锁芯序号
true
integer(int64)
openerCnName
钥匙名称
true
string
参数名称
参数说明
请求类型
必须
数据类型
schema
openerId
钥匙 ID
true
integer(int64)
openerState
钥匙状态：1.借出，2.归还
true
integer(int32)
openerType
钥匙类型：1.无授权， 2.一次授权，3.二次授权
true
integer(int32)
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
permissionState
授权状态：1.授权中， 2.授权失败，3.授权成功，4.授权过期
true
integer(int32)
remark
备注
false
string
searchValue
搜索值
false
string
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
uuid
全局唯一主键
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
msg
消息内容
string
响应示例
{
}
"code": 0,
"data": {},
"msg": ""
2.18.6 查询借还记录列表接口
接口地址
POST http://serverIp:port/prod-api/getRecordList接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
"applyTime": "",
"backStaffId": 0,
"backStaffName": "", "backTime": "",
"beginApplyTime": "", "borrowTime": "",
"createBy": "",
"createTime": "", "deptId": 0,
"endApplyTime": "", "isAsc": "asc,desc",
"lendStaffId": 0,
"lendStaffName": "",
"lockerName": "", "lockholeSort": 0, "openerCnName": "",
"openerId": 0,
"openerState": 0, "openerType": 0,
"orderByColumn": "",
"pageNum": 0,
"pageSize": 0,
"params": {},
"permissionState": 0,
"remark": "",
"searchValue": "",
"updateBy": "",
"updateTime": "",
"uuid": ""
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
借还&授权记录业务对象
借还&授权记录业务对象
body
true
借还&授权记录业务对象
借还&授权
记录业务对象
applyTime
申请时间
false
string(date- time)
backStaffId
归还员工 ID
true
integer(int64)
backStaffName
归还员工名称
true
string
backTime
归还时间
false
string(date- time)
beginApplyTime
申请时间起始日期：
YYYY-MM-DD HH:mm:ss
false
string
borrowTime
借出时间
false
string(date- time)
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门 ID
false
integer(int64)
endApplyTime
申请时间结束日期：
YYYY-MM-DD HH:mm:ss
false
string
isAsc
排序的方向
false
string
lendStaffId
借出员工 ID
true
integer(int64)
lendStaffName
借出员工名称
true
string
lockerName
锁柜名称
true
string
lockholeSort
锁芯序号
true
integer(int64)
参数名称
参数说明
请求类型
必须
数据类型
schema
openerCnName
钥匙名称
true
string
openerId
钥匙 ID
true
integer(int64)
openerState
钥匙状态：1.借出，2.归还
true
integer(int32)
openerType
钥匙类型：1.无授权， 2.一次授权，3.二次授权
true
integer(int32)
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
params
请求参数
false
object
permissionState
授权状态：1.授权中， 2.授权失败，3.授权成功，4.授权过期
true
integer(int32)
remark
备注
false
string
searchValue
搜索值
false
string
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
uuid
全局唯一主键
false
string
响应状态
参考“3.统一响应状态”
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
参数名称
参数说明
类型
schema
msg
消息内容
string
响应示例
{
}
"code": 0,
"data": {},
"msg": ""
2.18.7 查询告警记录列表接口
接口地址
POST http://serverIp:port/prod-api/getWarningList接口描述
请求数据类型
application/x-www-form-urlencoded,application/json
响应数据类型
*/*
请求示例
{
"beginWarningTime": "", "borrowTime": "",
"createBy": "",
"createTime": "",
"deptId": 0,
"endWarningTime": "", "isAsc": "asc,desc",
"lockerName": "", "lockholeSort": 0, "openerCnName": "",
"openerId": 0,
"openerType": 0,
"orderByColumn": "",
"pageNum": 0,
"pageSize": 0,
"params": {},
"permissionUuid": "",
"remark": "",
"searchValue": "",
"staffId": 0,
"staffName": "",
"type": 0,
"updateBy": "",
"updateTime": "",
"uuid": "",
"warningTime": ""
}
请求参数
参数名称
参数说明
请求类型
必须
数据类型
schema
告警记录业务对象
告警记录业务对象
body
true
告警记录业务对象
告警记录业务对象
beginWarningTime
false
string
borrowTime
借出时间
false
string(date- time)
createBy
创建者
false
string
createTime
创建时间
false
string(date- time)
deptId
创建者部门 ID
false
integer(int64)
endWarningTime
false
string
isAsc
排序的方向
false
string
lockerName
锁柜名称
true
string
lockholeSort
锁芯序号
true
integer(int64)
openerCnName
钥匙名称
true
string
openerId
钥匙 ID
true
integer(int64)
openerType
钥匙类型：1.无授权，2.一次授权，3.二次授权
true
integer(int32)
orderByColumn
排序列
false
string
pageNum
当前页数
false
integer(int32)
pageSize
分页大小
false
integer(int32)
参数名称
参数说明
请求类型
必须
数据类型
schema
params
请求参数
false
object
permissionUuid
同步到后台 Permission 主键
false
string
remark
备注
false
string
searchValue
搜索值
false
string
staffId
员工 ID
true
integer(int64)
staffName
借出员工
true
string
type
告警类型：1、当前告警；
2 历史告警
false
integer(int32)
updateBy
更新者
false
string
updateTime
更新时间
false
string(date- time)
uuid
同步到后台的主键
false
string
warningTime
告警时间
false
string(date- time)
响应状态
状态码
说明
schema
200
OK
请求响应对象
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
响应参数
参数名称
参数说明
类型
schema
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
msg
消息内容
string
响应示例
{
"code": 0,
"data": {},
"msg": ""
}
2.18.8 单点登录接口
接口地址
POST http://serverIp:port/thirdPlatlogin?username=zhangsan 接口描述
接口调用成功后直接重定向至钥匙柜系统首页
请求数据类型
application/x-www-form-urlencoded
响应数据类型
*/*
请求参数
参数名称
参数说明
请求类型
必须
数据类型
备注
username
登录账号
path
true
string
账号
响应状态
响应参数无
响应参数
参数名称
参数说明
类型
备注
code
消息状态码
integer(int32)
integer(int32)
data
数据对象
object
参数名称
参数说明
类型
备注
token
Token 值
string
msg
消息内容
string
响应示例
{
"code": 200,
"msg": "操作成功",
"data": {
"token": "eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImZlNWFlMzY0LTQ3MDctNGQ3 Yi05ODMxLTY0MGFhMjE1Yzk5OSJ9.gBLtnoSWZWKvGumDL0Srkh8p9FXdv_jr4QWAYzwXOGAO3iagylhNanajsa ekRJDCMz9Q_4mjbKZGBv6vnmLAcQ"
}
}
3.统一响应状态
状态码
说明
注释
200
OK
成功
401
Unauthorized
认证失败，无法访问系统资源
403
Forbidden
服务器拒绝请求
404
Not Found
未找到/不存在
500
InternalServerError
服务器内部错误（详细错误参考实际返回的错误信息）
4.数据字典
字典名称
字典类型
字典标签
字典值
字典序号
锁柜状态
kms_locker_status
离线
1
1
正常
2
2
停用
10
3
故障
20
4
锁芯状态
kms_lockhole_status
正常
1
1
停用
10
2
故障
20
3
员工类型
kms_staff_type
普通用户
1
1
授权用户
2
2
高级授权
3
3
钥匙类型
kms_opener_type
免授权
1
1
一次授权
2
2
二次授权
3
3
钥匙状态
kms_opener_status
在柜
1
1
借出
2
2
录入
3
3
丢失
10
4
员工状态
kms_staff_status
正常
1
1
停用
2
2
授权状态
kms_permission_status
授权中
1
1
拒绝借出
2
2
授权成功
3
3
授权过期
4
4
互斥组类型
kms_mutex_type
组内互斥
1
1
组间互斥
2
2
钥匙状态 2
kms_opener_status2
借出
1
1
归还
2
2
申请单状态
kms_apply_bill_status
提交
1
1
审批通过
2
2
审批驳回
3
3
关闭
4
4
是否创建
管理系统用户
kms_staff_create_sys_user
是
0
1
否
1
2
告警类型
warning_type
当前告警
1
1
历史告警
2
2
Reference in New Issue View Git Blame Copy Permalink