1. 人员管理
人员管理
1.1. 根据uuid返回人员信息
基础信息
路径: /v1/api/person/query
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuid | string | 是 | 员工、访客uuid |
Body示例:
{
"uuid": "79e57e0e256a4b3eba694c5ff96cc360"
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─uuid | string | 是 | 用户UUID | |
|─name | string | 是 | 用户名 | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3关注人员 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─imageUri | string | 否 | 用户识别照片的url | |
|─code | string | 否 | 员工编码,员工非必须,唯一 | |
|─identifyNum | string | 否 | 身份证号 | |
|─visitStartTime | string | 否 | 拜访起始时间(时间戳,毫秒), 访客必须 或 员工入职时间 | |
|─visitEndTime | string | 否 | 拜访结束时间(时间戳,毫秒), 访客必须 或 员工离职时间 | |
|─entryTime | string | 否 | 入职时间(时间戳, 毫秒), 员工非必须 | |
|─visitReason | string | 否 | 拜访原因, 访客非必须 | |
|─visitedUuid | string | 否 | 受访人的UUID,访客必须 | |
|─visitedName | string | 否 | 受访人的姓名, 访客必须 | |
|─visitType | integer | 否 | 访客类型, 访客必须, 1 普通访客, 2 VIP | |
|─visitedStatus | boolean | 否 | 访客状态, 访客必须, true 有效, false 无效 | |
string | 否 | 邮箱 | ||
|─phone | string | 否 | 手机号 | |
|─cardNum | string | 否 | 卡号,员工非必须, 唯一 | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工非必须 | |
|─postion | string | 否 | 职位, 员工非必须 | |
|─birthday | string | 否 | 生日(时间戳,毫秒), 员工非必须 | |
|─uniqueIdentify | string | 否 | 唯一标识, 唯一 | |
|─ext | string | 否 | 备注 | |
|─groupList | array | 否 | 人员所属组列表 | |
|─ | object | |||
|─uuid | string | 否 | 组uuid | |
|─name | string | 否 | 组名 | |
|─tagList | array | 否 | 身份 | |
|─ | object | |||
|─tagUuid | string | 否 | ||
|─tagName | string | 否 | ||
|─visitFirm | string | 否 | 访客所属单位, 访客非必须 | |
|─orgUuid | string | 否 | 组织Uuid | |
|─orgName | string | 否 | 组织名称 | |
|─visitStatus | integer | 否 | 访客预约状态(10待审批 20预约 30取消预约 40审批拒绝 50过期 60待审批已删除 | |
|─profilePhotoUri | string | 否 | 头像的url | |
|─autograph | string | 否 | 个性签名 | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri |
响应示例:
{
"code":0,
"data":{
"autograph":"test",
"birthday":1697472000000,
"cardBegin":"2023-11-01",
"cardEnd":"2023-12-31",
"cardNum":"13244400",
"code":"XX",
"email":"xx@qq.com",
"entryTime":1698768000000,
"ext":"test",
"groupList":[],
"identifyNum":"637A729DBBDBF316078AE9256315306322BDA608E934DA1AD252D03DFA1DD76B",
"imageUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25n-6145cd168844dbe00884a16a49360070.jpg",
"name":"XX",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"password":"999888",
"personFloor":{
"authFloors":[
-2
],
"defaultFloors":[
-2
]
},
"phone":"F0CF01A799704C7EFEC530293D258DB5",
"postion":"test",
"profilePhotoUri":"",
"sex":2,
"tagList":[
{
"tagName":"员工",
"tagUuid":"94523eed1ca347bd94dc712678c7fa4d"
}
],
"type":1,
"uuid":"79e57e0e256a4b3eba694c5ff96cc360",
"visitEndTime":1703952000000,
"visitStartTime":1698768000000,
"visitType":1,
"visitedStatus":false
},
"msg":"成功"
}
1.2. 批量添加人员
基础信息
路径: /v1/api/person/batchAdd
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
personList | array | 是 | 用户列表,单次仅支持批量添加1-200个人员 | |
|─ | object | |||
|─name | string | 是 | 用户名, 长度:[1,100] | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3 关注人员 | |
|─autograph | string | 否 | 个性签名 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─uuid | string | 否 | uuid, 若填写需保证唯一, 最大长度32位 | |
|─imageUri | string | 否 | 用户识别照片的uri | |
|─profilePhotoUri | string | 否 | 头像uri | |
|─code | string | 否 | 员工编码,员工可填,若填写需保证唯一, 格式: 允许大小写英文字母,数字, 长度:[1,32] | |
|─identifyNum | string | 否 | AES加密的身份证号, 格式:允许大小写英文字母,数字, 解密后长度:[18] | |
|─uniqueIdentify | string | 否 | 唯一标识, 若填写需要保证唯一, 格式:最大40位数字、字母和ascii码的字符 | |
|─visitFirm | string | 否 | 访客所属单位, 访客可填, 格式:汉字,大小写英文字母,数字, 长度: [1,40] | |
|─visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳, 毫秒), 访客必填 或 员工入职日期 | |
|─visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳, 毫秒), 访客必填 或 员工离职日期 | |
|─visitReason | string | 否 | 拜访原因, 访客可填,格式: 任意字符, 长度: [1, 255] | |
|─visitedUuid | string | 否 | 受访人的uuid, 访客必填 | |
|─visitType | integer | 否 | 访客类型, 访客可填, 1 普通访客, 2 VIP | |
string | 否 | 邮箱, 格式: 符合一般邮箱格式即可 | ||
|─phone | string | 否 | AES加密的手机号, 格式:数字, 解密后长度:[6,18],访客类型手机号必填,其他人员类型非必填 | |
|─cardNum | string | 否 | 卡号,若填写需保证唯一, 格式: 数字;加密方式为只读物理卡号时,取值范围[0,4294967295];加密方式为非只读物理卡号时,如果卡号位数为8,取值范围为[0, 16777215],如果卡号位数为10,取值范围为[0, 4294967295] | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工可填,格式: 数字, 长度:[4,6] | |
|─entryTimeStamp | integer | 否 | 入职时间(时间戳, 毫秒), 基础人员填写生效,其他填写不生效 | |
|─postion | string | 否 | 职位, 员工可填,格式: 任意字符, 长度: [0,64] | |
|─birthdayStamp | integer | 否 | 生日(时间戳, 毫秒) | |
|─ext | string | 否 | 备注, 格式: 任意字符, 长度:[0,255] | |
|─groupList | array | 否 | 加入的组uuid集合 | |
|─ | string | |||
|─tagList | array | 否 | 人员标签(身份) | |
|─ | object | |||
|─tagUuid | string | 是 | ||
|─orgUuid | string | 否 | 组织UUID,基础人员必填 | |
|─visitStatus | integer | 否 | 访问状态 | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri |
Body示例:
{
"personList": [
{
"name": "",
"type": 0,
"autograph": "",
"sex": 0,
"uuid": "",
"imageUri": "",
"profilePhotoUri": "",
"code": "",
"identifyNum": "",
"uniqueIdentify": "",
"visitFirm": "",
"visitStartTimeStamp": 0,
"visitEndTimeStamp": 0,
"visitReason": "",
"visitedUuid": "",
"visitType": 0,
"email": "",
"phone": "",
"cardNum": "",
"cardBegin": "",
"cardEnd": "",
"password": "",
"entryTimeStamp": 0,
"postion": "",
"birthdayStamp": 0,
"ext": "",
"groupList": [
""
],
"orgUuid": "",
"visitStatus": 0,
"personFloor": {
"defaultFloors": [
0
],
"authFloors": [
0
]
},
"palmPrintsLeftUri": "",
"palmPrintsRightUri": "",
"palmPrintsLeftIrUri": "",
"palmPrintsRightIrUri": ""
}
]
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─successes | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 成功列表 |
|─ | object | |||
|─name | string | 是 | 用户名 | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3关注人员 | |
|─autograph | string | 否 | 个性签名 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─uuid | string | 是 | uuid, 若填写需保证唯一, 最大长度32位 | |
|─imageUri | string | 否 | 用户识别照片的uri | |
|─staffCode | string | 否 | 员工编码,员工可填,若填写需保证唯一, 格式: 允许大小写英文字母,数字, 长度:[1,32] | |
|─identifyNum | string | 否 | 身份证号, 格式:允许大小写英文字母,数字, 长度:[1,32] | |
|─visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳,毫秒), 访客必填 或 员工入职日期 | |
|─visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳,毫秒), 访客必填 或 员工离职日期 | |
|─visitReason | string | 否 | 拜访原因, 访客可填,格式: 任意字符, 长度: [1, 255] | |
|─visitedUuid | string | 否 | 受访人的uuid, 访客必填 | |
|─visitType | integer | 否 | 访客类型, 访客可填, 1 普通访客, 2 VIP | |
string | 否 | 邮箱, 格式: 符合一般邮箱格式即可 | ||
|─entryTimeStamp | integer | 否 | 入职时间(时间戳, 毫秒), 基础人员可填 | |
|─phone | string | 否 | 手机号, 格式:数字, 长度:[6,18] | |
|─cardNum | string | 否 | 卡号, 格式: 数字 | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工可填,格式: 数字, 长度:[4,6] | |
|─postion | string | 否 | 职位, 员工可填,格式: 任意字符, 长度: [1,64] | |
|─birthdayStamp | integer | 否 | 生日(时间戳,毫秒) | |
|─ext | string | 否 | 备注, 格式: 任意字符, 长度:[1,255] | |
|─groupList | array | 否 | 加入的组uuid集合 | |
|─ | string | |||
|─orgUuid | string | 否 | 组织UUID | |
|─profilePhotoUri | string | 否 | 头像uri | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri | |
|─code | integer | 否 | 结果状态码 | |
|─msg | string | 否 | 结果信息提示 | |
|─failures | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 失败列表 |
|─ | object | |||
|─name | string | 是 | 用户名 | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3关注人员 | |
|─autograph | string | 否 | 个性签名 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─uuid | string | 是 | uuid, 若填写需保证唯一, 最大长度32位 | |
|─imageUri | string | 否 | 用户识别照片的uri | |
|─staffCode | string | 否 | 员工编码,员工可填,若填写需保证唯一, 格式: 允许大小写英文字母,数字, 长度:[1,32] | |
|─identifyNum | string | 否 | 身份证号, 格式:允许大小写英文字母,数字, 长度:[1,32] | |
|─visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳,毫秒), 访客必填 或 员工入职日期 | |
|─visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳,毫秒), 访客必填 或 员工离职日期 | |
|─visitReason | string | 否 | 拜访原因, 访客可填,格式: 任意字符, 长度: [1, 255] | |
|─visitedUuid | string | 否 | 受访人的uuid, 访客必填 | |
|─visitType | integer | 否 | 访客类型, 访客可填, 1 普通访客, 2 VIP | |
string | 否 | 邮箱, 格式: 符合一般邮箱格式即可 | ||
|─entryTimeStamp | integer | 否 | 入职时间(时间戳, 毫秒), 基础人员可填 | |
|─phone | string | 否 | 手机号, 格式:数字, 长度:[6,18] | |
|─cardNum | string | 否 | 卡号, 格式: 数字 | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工可填,格式: 数字, 长度:[4,6] | |
|─postion | string | 否 | 职位, 员工可填,格式: 任意字符, 长度: [1,64] | |
|─birthdayStamp | integer | 否 | 生日(时间戳,毫秒) | |
|─ext | string | 否 | 备注, 格式: 任意字符, 长度:[1,255] | |
|─groupList | array | 否 | 加入的组uuid集合 | |
|─ | string | |||
|─orgUuid | string | 否 | 组织UUID | |
|─profilePhotoUri | string | 否 | 头像uri | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri | |
|─code | integer | 否 | 结果状态码 | |
|─msg | string | 否 | 结果信息提示 |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"successes": [
{
"name": "",
"type": 0,
"autograph": "",
"sex": 0,
"uuid": "",
"imageUri": "",
"staffCode": "",
"identifyNum": "",
"visitStartTimeStamp": 0,
"visitEndTimeStamp": 0,
"visitReason": "",
"visitedUuid": "",
"visitType": 0,
"email": "",
"entryTimeStamp": 0,
"phone": "",
"cardNum": "",
"cardBegin": "",
"cardEnd": "",
"password": "",
"postion": "",
"birthdayStamp": 0,
"ext": "",
"groupList": [
""
],
"orgUuid": "",
"profilePhotoUri": "",
"personFloor": {
"defaultFloors": [
0
],
"authFloors": [
0
]
},
"palmPrintsLeftUri": "",
"palmPrintsRightUri": "",
"palmPrintsLeftIrUri": "",
"palmPrintsRightIrUri": "",
"code": 0,
"msg": ""
}
],
"failures": [
{
"name": "",
"type": 0,
"autograph": "",
"sex": 0,
"uuid": "",
"imageUri": "",
"staffCode": "",
"identifyNum": "",
"visitStartTimeStamp": 0,
"visitEndTimeStamp": 0,
"visitReason": "",
"visitedUuid": "",
"visitType": 0,
"email": "",
"entryTimeStamp": 0,
"phone": "",
"cardNum": "",
"cardBegin": "",
"cardEnd": "",
"password": "",
"postion": "",
"birthdayStamp": 0,
"ext": "",
"groupList": [
""
],
"orgUuid": "",
"profilePhotoUri": "",
"personFloor": {
"defaultFloors": [
0
],
"authFloors": [
0
]
},
"palmPrintsLeftUri": "",
"palmPrintsRightUri": "",
"palmPrintsLeftIrUri": "",
"palmPrintsRightIrUri": "",
"code": 0,
"msg": ""
}
]
}
}
1.3. 批量删除人员
基础信息
路径: /v1/api/person/batchDelete
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuidList | array | 是 | 用户UUID列表 | |
|─ | string |
Body示例:
{
"uuidList": [
"0b98e5ea637e41ac98aa5179b0b96217"
]
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─successes | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 成功列表 |
|─ | object | |||
|─uuid | string | 是 | uuid | |
|─code | integer | 否 | 结果状态码 | |
|─msg | string | 否 | 结果信息提示 | |
|─failures | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 失败列表 |
|─ | object | |||
|─uuid | string | 是 | uuid | |
|─code | integer | 否 | 结果状态码 | |
|─msg | string | 否 | 结果信息提示 |
响应示例:
{
"code":0,
"data":{
"failures":[],
"successes":[
{
"uuid":"0b98e5ea637e41ac98aa5179b0b96217"
}
]
},
"msg":"成功"
}
1.4. 修改人员
基础信息
路径: /v1/api/person/update
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuid | string | 是 | 用户UUID | |
name | string | 否 | 用户名, 长度:[1,100] | |
sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
imageUri | string | 否 | 用户识别照片的uri | |
profilePhotoUri | string | 否 | 头像uri | |
autograph | string | 否 | 个性签名 | |
uniqueIdentify | string | 否 | 唯一标识, 若填写需要保证唯一, 格式:最大40位数字、字母和ascii码的字符 | |
code | string | 否 | 员工编码,员工可填,若填写需保证唯一, 格式: 允许大小写英文字母,数字, 长度:[1,32] | |
identifyNum | string | 否 | 身份证号, 格式:允许大小写英文字母,数字, 长度:[1,32] | |
visitFirm | string | 否 | 访客所属单位, 访客可填, 格式:汉字,大小写英文字母,数字, 长度: [1,40] | |
visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳,毫秒), 访客必填 或 员工入职日期 | |
visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳,毫秒), 访客必填 或 员工离职日期 | |
entryTimeStamp | integer | 否 | 入职时间(时间戳, 毫秒), 基础人员填写生效,其他填写不生效 | |
visitReason | string | 否 | 拜访原因, 访客可填,格式: 任意字符, 长度: [1, 255] | |
visitedUuid | string | 否 | 受访人的uuid, 访客必填 | |
visitType | integer | 否 | 访客类型, 访客可填, 1 普通访客, 2 VIP | |
string | 否 | 邮箱, 格式: 符合一般邮箱格式即可 | ||
phone | string | 否 | 手机号, 格式:数字, 长度:[6,18] | |
cardNum | string | 否 | 卡号,如果存在不能修改,若填写需保证唯一, 格式: 数字;加密方式为只读物理卡号时,取值范围[0,4294967295];加密方式为非只读物理卡号时,如果卡号位数为8,取值范围为[0, 16777215],如果卡号位数为10,取值范围为[0, 4294967295] | |
cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
password | string | 否 | 密码, 员工可填,格式: 数字, 长度:[4,6] | |
postion | string | 否 | 职位, 员工可填,格式: 任意字符, 长度: [0,64] | |
birthdayStamp | integer | 否 | 生日(时间戳,毫秒) | |
ext | string | 否 | 备注, 格式: 任意字符, 长度:[0,255] | |
groupList | array | 否 | 加入的组集合,传空,人组关系不做修改;传[],清空人员绑定得组;传["a", "b"],将之前所有得人组关系解绑,重新和组a,b绑定 | |
|─ | string | |||
tagList | array | 否 | 人员标签(身份) | |
|─ | string | |||
orgUuid | string | 否 | 组织UUID | |
personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
palmPrintsRightIrUri | string | 否 | 右掌纹IR uri |
Body示例:
{
"uuid": "",
"name": "",
"sex": 0,
"imageUri": "",
"profilePhotoUri": "",
"autograph": "",
"uniqueIdentify": "",
"code": "",
"identifyNum": "",
"visitFirm": "",
"visitStartTimeStamp": 0,
"visitEndTimeStamp": 0,
"entryTimeStamp": 0,
"visitReason": "",
"visitedUuid": "",
"visitType": 0,
"email": "",
"phone": "",
"cardNum": "",
"cardBegin": "",
"cardEnd": "",
"password": "",
"postion": "",
"birthdayStamp": 0,
"ext": "",
"groupList": [
"4b238e3581cc4361847bda6a98c5f26e"
],
"tagList": [
"94523eed1ca347bd94dc712678c7fa4f"
],
"orgUuid": "",
"personFloor": {
"defaultFloors": [
0
],
"authFloors": [
0
]
},
"palmPrintsLeftUri": "",
"palmPrintsRightUri": "",
"palmPrintsLeftIrUri": "",
"palmPrintsRightIrUri": ""
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 |
响应示例:
{
"code": 0,
"msg": "",
"data": null
}
1.5. 上传人员图片
基础信息
路径: /v1/api/person/uploadImage
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | multipart/form-data | 是 |
表单:
名称 | 值 | 必须 | 类型 | 备注 |
---|---|---|---|---|
file | 是 | file | 上传人脸图片文件,接口内部包含了人脸质量判断,图片压缩等处理,适用于需要上传人脸的所有场景, 最大10m,支持格式:jpg,jpeg,bmp,png,JPG,JPEG,BMP,PNG |
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─uri | string | 是 | 上传返回的uri |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"uri": ""
}
}
1.6. 上传人员图片(使用非系统入库参数,适用于1:N图片上传等场景,不建议入库)
基础信息
路径: /v1/api/person/config/uploadImage
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | multipart/form-data | 是 |
表单:
名称 | 值 | 必须 | 类型 | 备注 |
---|---|---|---|---|
file | 是 | file | 上传人脸图片文件,接口内部包含了人脸质量判断(按照最低标准进行判断),图片压缩等处理,适用于需要上传人脸等场景,不建议入库使用, 最大10m,支持格式:jpg,jpeg,bmp,png,JPG,JPEG,BMP,PNG |
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─uri | string | 是 | 上传返回的uri |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"uri": ""
}
}
1.7. 根据uuid列表返回人员详细信息列表
基础信息
路径: /v1/api/person/uuid/list
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuidList | array | 是 | 人员UUID列表 | |
|─ | string |
Body示例:
{
"uuidList": [
"c1158f0086444b008543fa3689eabdd8"
]
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | array | 否 | 具体的返回值 | |
|─ | object | |||
|─uuid | string | 是 | 用户UUID | |
|─name | string | 是 | 用户名 | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3关注人员 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─imageUri | string | 否 | 用户识别照片的url | |
|─code | string | 否 | 员工编码,员工非必须,唯一 | |
|─identifyNum | string | 否 | 身份证号 | |
|─visitStartTime | string | 否 | 拜访起始时间(时间戳,毫秒), 访客必须 或 员工入职时间 | |
|─visitEndTime | string | 否 | 拜访结束时间(时间戳,毫秒), 访客必须 或 员工离职时间 | |
|─entryTime | string | 否 | 入职时间(时间戳, 毫秒), 员工非必须 | |
|─visitReason | string | 否 | 拜访原因, 访客非必须 | |
|─visitedUuid | string | 否 | 受访人的UUID,访客必须 | |
|─visitedName | string | 否 | 受访人的姓名, 访客必须 | |
|─visitType | integer | 否 | 访客类型, 访客必须, 1 普通访客, 2 VIP | |
|─visitedStatus | boolean | 否 | 访客状态, 访客必须, true 有效, false 无效 | |
string | 否 | 邮箱 | ||
|─phone | string | 否 | 手机号 | |
|─cardNum | string | 否 | 卡号,员工非必须, 唯一 | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工非必须 | |
|─postion | string | 否 | 职位, 员工非必须 | |
|─birthday | string | 否 | 生日(时间戳,毫秒), 员工非必须 | |
|─uniqueIdentify | string | 否 | 唯一标识, 唯一 | |
|─ext | string | 否 | 备注 | |
|─groupList | array | 否 | 人员所属组列表 | |
|─ | object | |||
|─uuid | string | 否 | 组uuid | |
|─name | string | 否 | 组名 | |
|─tagList | array | 否 | 身份 | |
|─ | object | |||
|─tagUuid | string | 否 | ||
|─tagName | string | 否 | ||
|─visitFirm | string | 否 | 访客所属单位, 访客非必须 | |
|─orgUuid | string | 否 | 组织Uuid | |
|─orgName | string | 否 | 组织名称 | |
|─visitStatus | integer | 否 | 访客预约状态(10待审批 20预约 30取消预约 40审批拒绝 50过期 60待审批已删除 | |
|─profilePhotoUri | string | 否 | 头像的url | |
|─autograph | string | 否 | 个性签名 | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri |
响应示例:
{
"code":0,
"data":[
{
"autograph":"",
"code":"test6",
"ext":"",
"groupList":[],
"imageUri":"",
"name":"test6",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-7c224cf48b8b30706e9432ee3c1712da",
"palmPrintsRightUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-772f74d9a25ffe428f025a9dd11d72d3",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"c1158f0086444b008543fa3689eabdd8",
"visitType":1
}
],
"msg":"成功"
}
1.8. 搜索人员列表
基础信息
路径: /v1/api/person/list
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
pageNum | integer | 否 | 1 | 分页页码,默认为 1 |
pageSize | integer | 否 | 20 | 分页大小,默认为 20 |
type | integer | 否 | 用户类别, 1 员工 2访客 3关注人员 | |
name | string | 否 | 用户姓名 | |
phone | string | 否 | 手机号 | |
identifyNum | string | 否 | 身份证号 | |
string | 否 | 邮箱 | ||
code | string | 否 | 员工编号 | |
cardNum | string | 否 | 卡号 | |
uniqueIdentify | string | 否 | 唯一标识 | |
staffEntryMinStamp | integer | 否 | 员工入职日期最小值(时间戳,毫秒) | |
staffEntryMaxStamp | integer | 否 | 员工入职日期最大值(时间戳,毫秒) | |
visitorCreateMinStamp | integer | 否 | 访客创建日期最小值(时间戳,毫秒) | |
visitorCreateMaxStamp | integer | 否 | 访客创建日期最大值(时间戳,毫秒) | |
simpleInfo | boolean | 否 | false | 是否仅返回简单信息(id+name), 默认false |
isPinyinOrder | boolean | 否 | true | 是否按拼音排序, 默认true |
visitType | integer | 否 | 访客类型(1 普通访客, 2 VIP访客) | |
visitedName | string | 否 | 受访员工姓名 | |
orgUuid | string | 否 | 组织uuid | |
visitStatus | integer | 否 | 访客状态(10待审批 20预约 30取消预约 40审批拒绝 |
Body示例:
{
"pageNum": 1,
"pageSize": 10,
"type": 1,
"name": "test"
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─pageNum | integer | 是 | 页码,从1开始 当前页码 |
|
|─pageSize | integer | 是 | 页面大小 分页大小 |
|
|─total | integer | 是 | 总记录数 总数 |
|
|─list | array | 否 | ||
|─ | object | |||
|─uuid | string | 是 | 用户UUID | |
|─name | string | 是 | 用户名 | |
|─type | integer | 是 | 用户类别, 1 员工 2访客 3关注人员 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─imageUri | string | 否 | 用户识别照片的url | |
|─profilePhotoUri | string | 否 | 头像的uri | |
|─code | string | 否 | 员工编码,员工非必须,唯一 | |
|─identifyNum | string | 否 | 身份证号 | |
|─visitStartTime | string | 否 | 拜访起始时间(时间戳,毫秒), 访客必须 或 员工入职日期 | |
|─visitEndTime | string | 否 | 拜访结束时间(时间戳,毫秒), 访客必须 或 员工离职日期 | |
|─visitReason | string | 否 | 拜访原因, 访客非必须 | |
|─visitedUuid | string | 否 | 受访人的UUID,访客必须 | |
|─visitedName | string | 否 | 受访人的姓名, 访客必须 | |
|─visitType | integer | 否 | 访客类型, 访客必须, 1 普通访客, 2 VIP | |
|─visitedStatus | boolean | 否 | 访客状态, 访客必须, true 有效, false 无效 | |
|─tagList | array | 否 | 身份 | |
|─ | object | |||
|─tagUuid | string | 否 | ||
|─tagName | string | 否 | ||
string | 否 | 邮箱 | ||
|─phone | string | 否 | 手机号 | |
|─cardNum | string | 否 | 卡号,员工非必须, 唯一 | |
|─cardBegin | string | 否 | 卡片生效日期,精确到天,格式为yyyy-MM-dd | |
|─cardEnd | string | 否 | 卡片失效日期,精确到天,格式为yyyy-MM-dd | |
|─password | string | 否 | 密码, 员工非必须 | |
|─postion | string | 否 | 职位, 员工非必须 | |
|─birthday | string | 否 | 生日(时间戳,毫秒), 员工非必须 | |
|─uniqueIdentify | string | 否 | 唯一标识, 唯一 | |
|─ext | string | 否 | 备注 | |
|─groupList | array | 否 | 人员所属组列表 | |
|─ | object | |||
|─uuid | string | 否 | 组uuid | |
|─name | string | 否 | 组名 | |
|─visitFirm | string | 否 | 访客所属单位, 访客非必须 | |
|─isPassRecord | boolean | 是 | 是否有通行记录 | |
|─isAttendanceRecord | boolean | 是 | 是否有考勤记录 | |
|─orgUuid | string | 否 | 组织Uuid | |
|─orgName | string | 否 | 组织名称 | |
|─visitStatus | integer | 否 | 访客预约状态(10待审批 20预约 30取消预约 40审批拒绝 50过期 60待审批已删除 | |
|─autograph | string | 否 | 个性签名 | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer | |||
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR uri | |
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR uri |
响应示例:
{
"code":0,
"data":{
"list":[
{
"autograph":"",
"code":"test1",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test1",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":1,
"tagList":[],
"type":1,
"uuid":"0b98e5ea637e41ac98aa5179b0b96217"
},
{
"autograph":"",
"code":"test2",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test2",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"6d8f8a755f1b4ebeb8afac6127e3d43a"
},
{
"autograph":"",
"code":"test3",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test3",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-9955b63e873d4c0833d1c422a91310e2",
"palmPrintsRightUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-42b812540a9d1512e81b9b39e909cca1",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"162ccf25cbe64f8a82f6dbbc3cb1097b",
"visitType":1
},
{
"autograph":"",
"code":"test4",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test4",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"1fb08b6b1bd444d8829fe279cae0bf4c"
},
{
"autograph":"",
"code":"test5",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test5",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"8a1d9f62e57b4c8782bd2969edb271fc"
},
{
"autograph":"",
"code":"test6",
"ext":"",
"groupList":[],
"imageUri":"",
"isAttendanceRecord":false,
"isPassRecord":false,
"name":"test6",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-7c224cf48b8b30706e9432ee3c1712da",
"palmPrintsRightUri":"Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-772f74d9a25ffe428f025a9dd11d72d3",
"password":"",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"postion":"",
"profilePhotoUri":"",
"sex":0,
"tagList":[],
"type":1,
"uuid":"c1158f0086444b008543fa3689eabdd8",
"visitType":1
}
],
"pageNum":1,
"pageSize":10,
"total":6
},
"msg":"成功"
}
1.9. 访客预约列表
基础信息
路径: /v1/api/person/visitor/pageLike
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
pageNum | integer | 否 | 1 | 非必须 当前页/数字类型 默认第一页 |
pageSize | integer | 否 | 10 | 非必须 每页条数/数字类型 默认10条 |
name | string | 否 | 用户姓名 | |
phone | string | 否 | 手机号 | |
identifyNum | string | 否 | 身份证号 | |
visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳) | |
visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳) | |
visitType | integer | 否 | 访客类型(1 普通访客, 2 VIP访客) | |
visitedName | string | 否 | 受访员工姓名 | |
visitStatus | integer | 否 | 访客状态(10待审批 20预约 30取消预约 40审批拒绝 | |
visitReason | string | 否 | 拜访原因 |
Body示例:
{
"pageNum": 1,
"pageSize": 10,
"name": "测试"
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─pageNum | integer | 是 | 页码,从1开始 当前页码 |
|
|─pageSize | integer | 是 | 页面大小 分页大小 |
|
|─total | integer | 是 | 总记录数 总数 |
|
|─list | array | 否 | ||
|─ | object | |||
|─uuid | string | 否 | 访客UUID | |
|─name | string | 否 | 用户名 | |
|─sex | integer | 否 | 性别, 0 未知, 1 男, 2 女 | |
|─imageUri | string | 否 | 用户识别照片的uri | |
|─identifyNum | string | 否 | 身份证号, 唯一 | |
|─visitStartTime | string | 否 | 拜访起始时间(时间戳) | |
|─visitEndTime | string | 否 | 拜访结束时间(时间戳) | |
|─visitReason | string | 否 | 拜访原因 | |
|─visitedUuid | string | 否 | 受访人的UUID,访客必须 | |
|─visitedName | string | 否 | 受访人的姓名, 访客必须 | |
|─visitType | integer | 否 | 访客类型, 1 普通访客, 2 VIP | |
string | 否 | 邮箱,唯一 | ||
|─phone | string | 否 | 手机号,唯一 | |
|─cardNum | string | 否 | 卡号,唯一 | |
|─cardBeginDate | string | 否 | 卡号起始时间 | |
|─cardEndDate | string | 否 | 卡号结束时间 | |
|─uniqueIdentify | string | 否 | 唯一标识 | |
|─ext | string | 否 | 备注 | |
|─groupList | array | 否 | 人员所属组列表 | |
|─ | object | |||
|─uuid | string | 否 | 组uuid | |
|─name | string | 否 | 组名 | |
|─visitFirm | string | 否 | 访客所属单位 | |
|─visitNumPlateList | array | 否 | 访客车牌号 | |
|─ | string | |||
|─isPassRecord | boolean | 否 | 是否有通行记录 | |
|─visitStatus | integer | 否 | 访客状态(10待审批 20预约 30取消预约 40审批拒绝 | |
|─gmtModified | string | 否 | 更新时间 | |
|─personFloor | object | 否 | 人员楼层 | |
|─defaultFloors | array | 否 | 默认楼层 | |
|─ | integer | |||
|─authFloors | array | 否 | 权限楼层 | |
|─ | integer |
响应示例:
{
"code":0,
"data":{
"list":[
{
"gmtModified":1698819701000,
"groupList":[
{
"name":"访客默认组",
"uuid":"23121432421342143124312421412444"
}
],
"isPassRecord":false,
"name":"测试访客",
"personFloor":{
"authFloors":[
0
],
"defaultFloors":[
0
]
},
"phone":"ED7DB6287CE840A81706EF76CCAC6AE8",
"sex":1,
"uuid":"0986f6bc0d9048479378c4769b5d3d2d",
"visitEndTime":1698854400000,
"visitFirm":"",
"visitNumPlateList":[],
"visitReason":"其他",
"visitStartTime":1698768000000,
"visitStatus":20,
"visitType":2,
"visitedName":"LX1",
"visitedUuid":"da982327972f46d6a1c4705cd4f7fa9f"
}
],
"pageNum":1,
"pageSize":10,
"total":1
},
"msg":"成功"
}
1.10. 根据员工、访客UUID获取二维码
基础信息
路径: /v1/api/person/visitorCode
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuid | string | 是 | 员工、访客uuid |
Body示例:
{
"uuid": "79e57e0e256a4b3eba694c5ff96cc360"
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─qrCode | string | 是 | 基础人员、访客二维码图片(base64编码的字符串) | |
|─expireTime | integer | 否 | 二维码图片的过期分钟数 |
响应示例:
{
"code":0,
"data":{
"expireTime":10,
"qrCode":"data:image/png;base64,R0lGODlhyADIAPAAAAAAAP///ywAAAAAyADIAEAC/4yPqcvtD6OctNpbgd68+/8lHTZeoOaUzOml7AsDk4oZdHCLp765IA8DyhC5RtFyXNxiKCJHyII+nb/agdmihrTDK1M4m1pxYtvXdPZie5Kkwh1mR9b0ptpulufxZH2fv1T217VHOAjGVRfUtmOUBhFYtaIIx4V4Z3hZiEUiWDkn6MPXKbmpOGbqp1kTxejXihk3akk7+RrqqJroiWu7helGuRo5i5oLyEt5W/pAbMh5/KysG1ubugjcmM1s3G391nudGb1K+puRjMwd/YkeI5o15ixFXUiP7d0Ovlxs/z1P7lu5gNV8rTEWLN1BgWj4jSvoD+K+c4cYgnLoTN+0d//exGXU5lGhxlPsRJqsN/HFQIPm4kUUJ+uhknAdt6m7Kc0hPISPKnbUd89lymEn8VEAKHFnzaVBkc5EObJO0JgJUTbdKHMQVqEx4W0luk5eUaFOfcJ0ZRTW035asS79yCwqW2G7wkIaC5ai2mY0u/5TmJcs3r9xacrNyjSx4sWMGzt+DDmyZIJWyk61eNamYJ1oEXf2q7ns3pV3OWu+avpl28JWCac1DHI1RaVJ675OLXszW9JHxwK1rXvhxd2Ye7eezJe1XpKnkTtX/ZvlZ1R7v1KPzdvrVsDXoXJvXht85rVcKSfHGRgu8dA9o7ubi70kRthSXedcn+97SI7izwf/P3xZeOOZxUpsltl3mHv+jQYcT7gxKBFdih3Inl3GwfeggRpaWBV+/gU4IG0DVkcfTgryRuF7WamnUnGgqRYYihui1xCGNPZH4nHQMVfajTCaB+B0j+XoI4EdejZciwIW6B1/IQqZX30Rlngfkj2WV6GH6fnWnn4L8pjSiYtBs+SRVHVpIYhDQcmkiWjaGJyaLZ05n45Gvmklgagt5+SFVYo2I5bk7Vnli35qx6GXZO6IG53bFdpgpEiAueiaBrH4XKaabsppp55+Cmqooo4q36PZmefoilRCuN80hs5ZHJGqKqckox6KueSWtMrpIpCDZQnplH0GCayufB4rqJ+V/8pK6KnC3uYmrZh2R4eaLKZoaavBkndtX/YhCu22uWHr7JXN1ljruPFJl6SDtz6KbIzfzvusuN1uROqlv2o7bb7+KruvutJ6+2+SR7KabW7gCmcuvYMCh7CIeqL7Krr3GtWSmRbDKy6s7NoaZ6l/rkrwlcSOWPLE9Up8cpheZpxyvz9+nLDGucYaaMU0AzqwndbdLFaTs4nMK7A8F8nY0coU/XC9CF+crrxGc1nn0EEj2zKzRPdqsKJUMu1y1XnKrDLKdi4sddNPDvn11u1ybXLKaSvcGa7crru2isbOGi3GNWErYWVtOx3w04PrTTHOGTbqcMIsk9ynxIbaDLKMjP8DXbnIEfva87tiW3s43Vfz3XHiO1MqN+dwzg365Q3jiHfYpv6Np6y2xxw62Vq/PbXPXvvuuuON3x783puvDPedwFfrttlW370rm6nurbPaje2eeZmp6xv9T5Bjvf3MgkuZvfV2f7hxoov3HTWb5CbvsYqGrz9y5O6/jGr6cB5vfqCBK+85VzXPU8sKXbkEBr7lJStBHFvYzxDHPQES7mzSMx2/8Ae7z1FrbP7DHQVPR76yiQ5k52OgBnmnrbmRzYEBs9zsvCe292kvhJWaXM4klbea4al66IvgAn8XLtZVcFL0U+ENM8g+F3JQge6yFxDrVyTsjVCELWMhvhDUwrr/1S52B8tiwb4IxjCKcYxkLKMZz4jGNKpxjWDkWMiIqCUcCq9YmnOLFuF1wDzKUYnzc2MA/ahHzMmOdFbcXwOHCEHxTbGLMXwiDx8JP9WRDnAd7J4iA2m9xw3Li5eUZOuCiEVL9jCFoVydBQH4nyOSUJWjRKAT1RdH5CExXUqToiZBScdZlhB1oiwgEyH2ROIlcYO+jBcwi1fKN0KPfVn7Hi2DycpbPlNoqUxT4wiltHMJEmp8pNofu7lJ+tkyf3CEYrIKaU7+iRCTc8zkKWt4xwT6jWaSOyU6/5fN4TlSn428YtfwyM8o7lOW5XPl/+7JS4EWMaCvVKgf89QpYaaz/5KxZONkJIpNTlq0j+0D4fMMGjsjUjOjCmTkR6lXR/t5tHQTnOcyJxnSZCLUmgSlojfP6ckNQvKfzOwJzEb6zvC1c6jTO6ZLAQbUcrqRnUpE6QzlCdMPXpCGQm2qTBUHVbTpbztMxWpDlTlIsKlTqyhcpAdN+VSWunOWTWymKOtZUyHSU45VzGlLzZmqYkLUnnskZ//EqVGSGnNCztxpQXUX094NNjEmXWJWU7pYVEamlgnFqS6dKUUZRsmhS+vrSrX5VwmGdqKdq+ZJg9pPtE71o5QNZ7jGer/UEtKoHT1sZSV6vk9adpXBG6dSBzpaEw6zrL513l59KFfeVrQblP8La2yXCzZpRndMBvTsaNsq1NZCV6d+naJ0iZldaJa0qpCN6nZrylHBHjduUv0SLHfbyhUmE7blBOdReahdvFrXpu1NLkj761WnGre5XY0rbXeZVOXqtz9WrS9qVSvZAEuYuJhNbCc/a9eC+tethlTp6wZ81gUbV5oIhrCCEEtTBeuWxORNKztRfNq7rliSJZ6tIOGq4OIeasIapisGx2fiyjaxwT1mayRlvF/1wnN0uL3pdJHM4PIeFLyl5WaSrxplHz6QuVuscmB5jEoYO5a0MbbtL7eZu8JFk8Y+zfA6rynlwvo4xa484IlZqc4pX/aE7I0sjt3LWeHW1qylzev/j4k6QPnOddGMxTNwEc1TsBr2zTCMbD4ZjVQ/c1fLX8b0T3GpSM22ybymXS+l5bdDMOe2u3q9M4A53cs0v/rDmf7hQhVr6kvT+i3h9XCE70pfM3+Tyh0usw697Fq1DnLJORRrmymMbFCf+r+stbB3aRs/Qov2131mmHNBpdc/Cxqj8bTxp8LN6hC3Wt3VhfW2lfzsXR841VkGMiDjHEL8HhLKm723uzvr4H+ju96jHvK8e+toOv9Zt3UN+GqVnVlrL3zOxrYyejtNSoI3Vs/2Bi23w8zuQqcboJUm81cFDOhSi3vf/fZ4wx/ucRvGWuTQlvbKqeprFgOWz/Glt7zLZBpzhkYcmSvV8YsrnGCQzxxpz53msB2+bFn39NYXXmsiP55flIt54mieNdYfPXRLr7nrf1wqlpuN76lDmOEhf6GKryxwJ4/8sZHesphdzbxcWl3b8LWo3/8O+MALfvCEL7waCwAAOw=="
},
"msg":"成功"
}
1.11. 删除访客预约
基础信息
路径: /v1/api/person/sub/delete
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuidList | array | 是 | uuid集合 | |
|─ | string |
Body示例:
{
"uuidList": [
""
]
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─successes | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 成功列表 |
|─ | string | |||
|─failures | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 失败列表 |
|─ | string |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"successes": [
""
],
"failures": [
""
]
}
}
1.12. 修改访客预约状态
基础信息
路径: /v1/api/person/status
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuidList | array | 是 | 人员UUID集合 | |
|─ | string | |||
visitStatus | integer | 是 | 访客预约状态(30取消预约 40审批拒绝 |
Body示例:
{
"uuidList": [
""
],
"visitStatus": 0
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─successes | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 成功列表 |
|─ | string | |||
|─failures | array | 是 | Collections.synchronizedList(new ArrayList<>()) | 失败列表 |
|─ | string |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"successes": [
""
],
"failures": [
""
]
}
}
1.13. 访客预约审批
基础信息
路径: /v1/api/person/visitor/edit
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
uuid | string | 是 | 访客Uuid | |
visitStartTimeStamp | integer | 否 | 拜访起始时间(时间戳) | |
visitEndTimeStamp | integer | 否 | 拜访结束时间(时间戳) | |
visitReason | string | 否 | 来访事由 | |
groupList | array | 否 | 加入的组集合 | |
|─ | object | |||
|─groupUuid | string | 是 | 组UUID | |
visitType | integer | 否 | 访客类型, 1 普通访客, 2 VIP | |
visitStatus | integer | 否 | 访客预约状态(20预约 40审批拒绝) |
Body示例:
{
"uuid": "",
"visitStartTimeStamp": 0,
"visitEndTimeStamp": 0,
"visitReason": "",
"groupList": [
{
"groupUuid": ""
}
],
"visitType": 0,
"visitStatus": 0
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 |
响应示例:
{
"code": 0,
"msg": "",
"data": null
}
1.14. 人员信息数量查询
基础信息
路径: /v1/api/person/count
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─personTotalNum | integer | 否 | 人员总数 | |
|─personFaceNum | integer | 否 | 人脸数量 | |
|─palmLeftNum | integer | 否 | 左掌纹数量 | |
|─palmRightNum | integer | 否 | 右掌纹数量 | |
|─cardNum | integer | 否 | 发卡数量 |
响应示例:
{
"code":0,
"data":{
"cardNum":1,
"palmLeftNum":4,
"palmRightNum":4,
"personFaceNum":1,
"personTotalNum":8
},
"msg":"成功"
}
1.15. 人员批量录入掌纹详情
基础信息
路径: /v1/api/person/batch/gather/detail
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
deviceUuid | string | 是 | 设备uuid | |
pageNum | integer | 否 | 1 | 页码,从1开始 当前页码,不传默认1 |
pageSize | integer | 否 | 20 | 页面大小 分页大小,不传默认20 |
Body示例:
{
"deviceUuid": "879cce50f17245bcb4fde3293e0bde03",
"pageNum": 1,
"pageSize": 10
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─pageNum | integer | 是 | 页码,从1开始 当前页码 |
|
|─pageSize | integer | 是 | 页面大小 分页大小 |
|
|─total | integer | 是 | 总记录数 总数 |
|
|─list | array | 否 | ||
|─ | object | |||
|─uuid | string | 否 | uuid | |
|─name | string | 否 | 用户名 | |
|─orgUuid | string | 否 | 组织UUID | |
|─orgName | string | 否 | 组织名称 | |
|─imageUri | string | 否 | 用户识别照片的uri | |
|─code | string | 否 | 员工编码,唯一 | |
|─phone | string | 否 | 手机号,唯一 | |
|─palmPrintsLeftUri | string | 否 | 左掌纹图片uri | |
|─palmPrintsRightUri | string | 否 | 右掌纹图片uri |
响应示例:
{
"code":0,
"data":{
"list":[
{
"code":"100001",
"imageUri":"",
"name":"LX1",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-48e7e52def328a875d505276d28ed11b",
"palmPrintsRightUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-46e8d0c9817faebffc3c4d6e4f94349d",
"phone":"c61176086aa3b4a780284b7f728bf501",
"uuid":"da982327972f46d6a1c4705cd4f7fa9f"
},
{
"code":"XX",
"imageUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25n-6145cd168844dbe00884a16a49360070.jpg",
"name":"XX",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-8ba3137c5373c802c9e940e4861a48cb",
"palmPrintsRightUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-d8f9527827821ffa0fe4809574c7390b",
"phone":"ac4141880990f2b5fdcff8a4b331549a",
"uuid":"79e57e0e256a4b3eba694c5ff96cc360"
},
{
"code":"test2",
"imageUri":"",
"name":"test2",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"uuid":"6d8f8a755f1b4ebeb8afac6127e3d43a"
},
{
"code":"test3",
"imageUri":"",
"name":"test3",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-b418aa4b47176610ce8329cea911aaa6",
"palmPrintsRightUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-e85f8d8130e11535e9b04e4f7c4f6355",
"uuid":"162ccf25cbe64f8a82f6dbbc3cb1097b"
},
{
"code":"test4",
"imageUri":"",
"name":"test4",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"uuid":"1fb08b6b1bd444d8829fe279cae0bf4c"
},
{
"code":"test5",
"imageUri":"",
"name":"test5",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"",
"palmPrintsRightUri":"",
"uuid":"8a1d9f62e57b4c8782bd2969edb271fc"
},
{
"code":"test6",
"imageUri":"",
"name":"test6",
"orgName":"默认部门",
"orgUuid":"0",
"palmPrintsLeftUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-132f78f32f508397db145132b7c2c0fa",
"palmPrintsRightUri":"http://169.42.42.42:28089/v1/storage/download/Z3NwOi8vd3Vrb25nLW1lZ2xpbms=-de570be47195f1f3ef6e02266c479a20",
"uuid":"c1158f0086444b008543fa3689eabdd8"
}
],
"pageNum":1,
"pageSize":10,
"total":8
},
"msg":"成功"
}
1.16. 人员单个录入掌纹详情
基础信息
路径: /v1/api/person/single/gather/detail
请求方法: POST
请求参数
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
Content-Type | application/json | 是 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
personUuid | string | 是 | 人员uuid |
Body示例:
{
"personUuid": ""
}
返回数据
Headers:
名称 | 值 | 必须 | 备注 |
---|---|---|---|
content-type | application/json;charset=UTF-8 | 否 |
Body:
名称 | 类型 | 必须 | 默认值 | 备注 |
---|---|---|---|---|
code | integer | 否 | 返回值code | |
msg | string | 否 | 返回值消息 | |
data | object | 否 | 具体的返回值 | |
|─personUuid | string | 否 | 人员uuid,用于前端映射 | |
|─palmPrintsLeftUri | string | 否 | 左掌纹RGB URI 左掌纹RGB URI |
|
|─palmPrintsLeftUrl | string | 否 | 左掌纹RGB URL | |
|─palmPrintsRightUri | string | 否 | 右掌纹RGB URI 右掌纹RGB URI |
|
|─palmPrintsRightUrl | string | 否 | 右掌纹RGB URL | |
|─palmPrintsLeftIrUri | string | 否 | 左掌纹IR URI 左掌纹IR URI |
|
|─palmPrintsRightIrUri | string | 否 | 右掌纹IR URI 右掌纹IR URI |
响应示例:
{
"code": 0,
"msg": "",
"data": {
"personUuid": "",
"palmPrintsLeftUri": "",
"palmPrintsLeftUrl": "",
"palmPrintsRightUri": "",
"palmPrintsRightUrl": "",
"palmPrintsLeftIrUri": "",
"palmPrintsRightIrUri": ""
}
}