1. 人员管理


1.1. 根据uuid返回人员信息

基础信息

路径: /v1/api/person/query

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuid string 是 员工、访客uuid

Body示例:

{
  "uuid": "343fe642be34486cb4957bb2b427448a"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
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 无效
  |─email 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 否 个性签名

响应示例:

{
  "code": 0,
  "data": {
    "groupList": [
      {
        "name": "默认访客组",
        "uuid": "23121432421342143124312421412444"
      }
    ],
    "name": "FK007",
    "orgName": "默认部门",
    "orgUuid": "0",
    "phone": "4DF1A573459E717021866ECC345F4BF2",
    "sex": 1,
    "tagList": [],
    "type": 2,
    "uuid": "4ce0f409692f4f2ba73adb3d04dd568b",
    "visitEndTime": 1679068800000,
    "visitFirm": "",
    "visitReason": "其他",
    "visitStartTime": 1678929828000,
    "visitStatus": 20,
    "visitType": 1,
    "visitedName": "Person01",
    "visitedStatus": true,
    "visitedUuid": "dde8cecd28534af29764ccd0722c833e"
  },
  "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
    |─email 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
    |─orgUuid string 否 组织UUID,基础人员必填
    |─visitStatus integer 否 访问状态

Body示例:

{
  "personList": [
    {
      "name": "Person009",
      "type": 1,
      "autograph": "这是个性签名",
      "sex": 0,
      "imageUri": "Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
      "profilePhotoUri": "Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
      "code": "Person009",
      "identifyNum": "7802b9f8d2ce09322ffd47e7f53164f5cca31d7baa04e2175c20619fde5b5a06",
      "uniqueIdentify": "2131234",
      "visitFirm": "",
      "visitStartTimeStamp": 1678946297332,
      "visitEndTimeStamp": 1679810297000,
      "visitReason": "面试",
      "visitedUuid": "dde8cecd28534af29764ccd0722c833e",
      "visitType": 1,
      "email": "",
      "phone": "8d9542b37c34485cedd56e2af3781d2e",

      "password": "",
      "postion": "老大",
      "birthdayStamp": 1678946297332,
      "ext": "",
      "groupList": [

      ],
      "orgUuid": "0",
      "visitStatus": 20
    }
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─successes array 是 成功列表
    |─ 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
      |─email 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
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示
  |─failures array 是 失败列表
    |─ 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
      |─email 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
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示

响应示例:

{
  "code": 0,
  "data": {
    "failures": [],
    "successes": [
      {
        "autograph": "这是个性签名",
        "birthdayStamp": 1678946297332,
        "email": "",
        "ext": "",
        "groupList": [],
        "identifyNum": "7802B9F8D2CE09322FFD47E7F53164F5CCA31D7BAA04E2175C20619FDE5B5A06",
        "imageUri": "Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
        "name": "Person009",
        "orgUuid": "0",
        "password": "",
        "phone": "8D9542B37C34485CEDD56E2AF3781D2E",
        "postion": "老大",
        "sex": 0,
        "staffCode": "Person009",
        "type": 1,
        "uuid": "8db4596fa1eb4721b7e347666c879378",
        "visitEndTimeStamp": 1679810297000,
        "visitReason": "面试",
        "visitStartTimeStamp": 1678946297332,
        "visitType": 1,
        "visitedUuid": "dde8cecd28534af29764ccd0722c833e"
      }
    ]
  },
  "msg": "成功"
}

1.3. 批量删除人员

基础信息

路径: /v1/api/person/batchDelete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuidList array 是 用户UUID列表
  |─ string  

Body示例:

{
  "uuidList":[
    "8db4596fa1eb4721b7e347666c879378"
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─successes array 是 成功列表
    |─ object
      |─uuid string 是 uuid
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示
  |─failures array 是 失败列表
    |─ object
      |─uuid string 是 uuid
      |─code integer 否 结果状态码
      |─msg string 否 结果信息提示

响应示例:

{
  "code": 0,
  "data": {
    "failures": [],
    "successes": [
      {
        "uuid": "8db4596fa1eb4721b7e347666c879378"
      }
    ]
  },
  "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
email 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

Body示例:

{
  "uuid": "3538c00670db4508a522eb3494090577",
  "name": "NewName",
  "sex": 0,
  "imageUri": "Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
  "code": "Person009",
  "identifyNum": "7802b9f8d2ce09322ffd47e7f53164f5cca31d7baa04e2175c20619fde5b5a06",
  "visitFirm": "",
  "visitStartTimeStamp": 1678946297332,
  "visitEndTimeStamp": 1679810297000,
  "visitReason": "",
  "visitedUuid": "",
  "email": "",
  "password": "",
  "postion": "",
  "birthdayStamp": 0,
  "ext": "",
  "groupList": [
    "4b238e3581cc4361847bda6a98c5f26e"
  ],
  "tagList": [
    "94523eed1ca347bd94dc712678c7fa4f"
  ],
  "orgUuid": "0"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

{
  "code": 0,
  "msg": "成功"
}

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 否
msg string 否
data object 否
  |─uri string 是 上传返回的uri

响应示例:

{
  "code": 0,
  "data": {
    "uri": "Z3NwOi8vd3Vrb25n-cf68b8ab5240976b6ab9f201f85522fb.jpg"
  },
  "msg": "成功"
}

1.6. 上传人员图片(人脸质量判断按照最低标准进行判断)

基础信息

路径: /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 否
msg string 否
data object 否
  |─uri string 是 上传返回的uri

响应示例:

{
  "code": 0,
  "data": {
    "uri": "Z3NwOi8vd3Vrb25n-490a83ae19d1dfcc9e2306eb45709db3.jpg"
  },
  "msg": "成功"
}

1.7. 根据uuid列表返回人员详细信息列表

基础信息

路径: /v1/api/person/uuid/list

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuidList array 是 人员UUID列表
  |─ string  

Body示例:

{
  "uuidList":["3538c00670db4508a522eb3494090577"]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
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 无效
    |─email 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 否 个性签名

响应示例:

{
  "code": 0,
  "data": [
    {
      "code": "Person009",
      "ext": "",
      "groupList": [],
      "identifyNum": "7802B9F8D2CE09322FFD47E7F53164F5CCA31D7BAA04E2175C20619FDE5B5A06",
      "imageUri": "http://169.42.42.42:8089/v1/storage/download/Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
      "name": "NewName",
      "orgName": "默认部门",
      "orgUuid": "0",
      "password": "",
      "phone": "8D9542B37C34485CEDD56E2AF3781D2E",
      "postion": "",
      "profilePhotoUri": "http://169.42.42.42:8089/v1/storage/download/Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
      "sex": 0,
      "tagList": [],
      "type": 1,
      "uniqueIdentify": "2131234",
      "uuid": "3538c00670db4508a522eb3494090577",
      "visitFirm": "",
      "visitReason": "",
      "visitStatus": 20,
      "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 否 身份证号
email 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示例:

{
  "name":"NewName"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─pageNum integer 是 当前页码
  |─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 否
      |─email 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 否 个性签名

响应示例:

{
  "code": 0,
  "data": {
    "list": [
      {
        "code": "Person009",
        "ext": "",
        "groupList": [],
        "identifyNum": "7802B9F8D2CE09322FFD47E7F53164F5CCA31D7BAA04E2175C20619FDE5B5A06",
        "imageUri": "http://169.42.42.42:8089/v1/storage/download/Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
        "isAttendanceRecord": false,
        "isPassRecord": false,
        "name": "NewName",
        "orgName": "默认部门",
        "orgUuid": "0",
        "password": "",
        "phone": "8D9542B37C34485CEDD56E2AF3781D2E",
        "postion": "",
        "profilePhotoUri": "http://169.42.42.42:8089/v1/storage/download/Z3NwOi8vd3Vrb25n-ea4c5059630dc52e1e2467ff3274eccf.jpg",
        "sex": 0,
        "tagList": [
          {
            "tagName": "学生",
            "tagUuid": "94523eed1ca347bd94dc712678c7fa4f"
          }
        ],
        "type": 1,
        "uniqueIdentify": "2131234",
        "uuid": "3538c00670db4508a522eb3494090577",
        "visitFirm": "",
        "visitReason": "",
        "visitStatus": 20,
        "visitType": 1
      }
    ],
    "pageNum": 1,
    "pageSize": 20,
    "total": 1
  },
  "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示例:

{"name": "", "pageNum": 1, "pageSize": 5}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─pageNum integer 是 当前页码
  |─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
      |─email 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 否 更新时间

响应示例:

{
  "code": 0,
  "data": {
    "list": [
      {
        "gmtModified": 1678930704000,
        "groupList": [
          {
            "name": "默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组",
            "uuid": "23121432421342143124312421412444"
          }
        ],
        "isPassRecord": false,
        "name": "FK008",
        "phone": "85B5B9DB67DBC3D3F67EB10C17810CD4",
        "sex": 1,
        "uuid": "06381ea6f89a4792b4fbd19e4f600123",
        "visitEndTime": 1679068800000,
        "visitFirm": "",
        "visitReason": "其他",
        "visitStartTime": 1678930693000,
        "visitStatus": 20,
        "visitType": 1,
        "visitedName": "Person01",
        "visitedUuid": "dde8cecd28534af29764ccd0722c833e"
      },
      {
        "gmtModified": 1678929838000,
        "groupList": [
          {
            "name": "默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组默认访客组",
            "uuid": "23121432421342143124312421412444"
          }
        ],
        "isPassRecord": false,
        "name": "FK007",
        "phone": "1E3091CBEB8955C64EA921DADA9166B8",
        "sex": 1,
        "uuid": "4ce0f409692f4f2ba73adb3d04dd568b",
        "visitEndTime": 1679068800000,
        "visitFirm": "",
        "visitReason": "其他",
        "visitStartTime": 1678929828000,
        "visitStatus": 20,
        "visitType": 1,
        "visitedName": "Person01",
        "visitedUuid": "dde8cecd28534af29764ccd0722c833e"
      }
    ],
    "pageNum": 1,
    "pageSize": 5,
    "total": 2
  },
  "msg": "成功"
}

1.10. 根据员工、访客UUID获取二维码

基础信息

路径: /v1/api/person/visitorCode

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuid string 是 员工、访客uuid

Body示例:

{
  "uuid": "3538c00670db4508a522eb3494090577"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─qrCode string 是 基础人员、访客二维码图片(base64编码的字符串)
  |─expireTime integer 否 二维码图片的过期分钟数

响应示例:

{
  "code": 0,
  "data": {
    "expireTime": 10,
    "qrCode": "data:image/png;base64,R0lGODlhyADIAPAAAAAAAP///ywAAAAAyADIAEAC/4yPqcvtD6OctNpbgd68+/8lHQZqIneCZMk67Aub0ogh9HEvrY3ycRrrMXIP4mozIQYBQKYP1lQKa4FlMzqtZq1PZ8R4kf6oum3wKPtm0V7I8m1Gdq/zOi6eNojzWvndrwcHl1TicjaD52EouMjX2NbnaBfISKawYwE2tDZZo0kZYolZBmgJ+vJIWGq6B6kqubna1frq2pnaQNv5aXqZSPcHNcupVirI13qMupvIFbz8PNqLZXxYjFyIWL0Ne8pbC+xNTBoa203BKw2uLWwOqTxNJj3/yyz7TI3N/V7v7pyRDR87aKdw+QtYMFc/cSrsnWNTi56yMddsCbzIsFxGRf/D7rkZ52uixkgcK0o8949kymQgw5HMZ5FcSZnqOo58lBLmyZieEBbxqQvjz4ZCWS0c+jBer5Ug01nb6DKqQqIyI4q8ORBemGZPQ+r7OnMpV6ovb03FepBiwmhAr4Y1um/nurTtoA7U6RPn2KRFt+6bu3ZjTXl7eX4zqzSx4sWMGzt+DDmy5MaHK0pl+9dmWK3uAPf06JWf2rKYUbbU7HKwXaEsyVYOrLIt6J05HYoGK9d2bsuiCr9G5/t057u9QU+2Grdp19/Hm9MUXpX4cMKz8/pFC1uv66PMs3IPTham+LNvpQuWbTq5cdSIYTvdXj08eYMf44NNDV1sZtbLrU//P79eJkfRR1p25hWIIH7y0WVYfgSOJ2CAAKaHW1dwYYfUZv7VR+FtDe73nH0f8sVheaXxRKBqCO7mnoPtrejiiZeFONJ7HbIYmoJ1wShhhp655eGPheEFYoLzvaijh7+pWNuJSx6j3Y7dUXcfe1SauNqEb8zII4kZ2qjkd+rdCOV1YVbCoHMl4sglU/B1iBycB0JkZYsiBmWgSRuG1pqXfWrYI5huYphkkzSe6Sd4VaZpJp1OokdQl0GaCSSeOdb5ZYxaPoipimp+Cmqooo5KaqmmnopqqplWuihAbyKKInmGxsZqrH1F2CqfYkpZ5n8+FpfomIBWKGKck8oo666w/1qaYn/C/smlsZbiOKitdvL67JBIevcqhNdG+mS2RXpL645JFgoput3O2ahmU5ZIpJfRbsubnrWeaxu+/BU5ba1YqkqbcqO9q2rBjCLLILMG64fhrOqSOdq8+8r56IJUeHpkvdFdGaW1q1K8Zrr5KkWtov8GfKemH5+cH8HN9ihxnlkaeSWTLav8srz0ylzusa4Siy3IPRvb5oCdCkzoi+EK3S/MwPosKco6T7ylbv7qq+WfWuOc8aYkG+2rwhpLmvO/D5vd7q0bf+so210PTanJQlp8KdUdXwg1xgiv/RnEU/Mc74jL7skGwVJ7XPS4Ix/Md8wMDws51jR/23Sugv9a+PWrleeNNKySi521yjbTXTaY5G7edt2AJ6t4wmDzXG3ZgUuOt7Qmcwbv21uLCzTiO0fd6+p2Hz3w66pP/uvYQDq++e6W39x67vaKRG7HoPfsfOSYyr49636zHLH3kQZ+fWLNc723rrxXrTbZlBFO/POBihxP+b8XDn2NyhJ9/4FL+86445VMWNbDnPLccjdUxe5ts4uf4PjnqwJeBX9o+tng6HY+p40tdQP8Hu24lbT06U140pvZ9ToIQK9Nz3P+c1auErhCFB4Od49rYPsSN4juhS14K6ue7lwoOMOJ7nZyWxwJj8fB/HGugjXU4RH/V7vfZdBcT/PhDaXorxP/amuFFGxY56C1sDCKcYxkLKMZz4jGNKpxjWxsoxuflkXHnW6LFpxVFv8Xx/6JkI7AYSL5eChB6unRhHy0HQbvOD8N8u1y/AKiHZUYxQ2mDXb0U2HoisUuXHkse2fjVADB+EllsemHxSMgA8XXSVQaEXvGO9sUHwjCJXpxXVQb5Q5L2TtQHjGQstRexV5IyqBdsHdyFN8rXdlKq9HyUH/E5PB+2UsbPrGI7ZvhnlDnrv1lM3oCBCIML8k0UVYSeMtM3sWoOQ1OTtKcfdsk+igHP01Ks4/B+hsSjYnAVWLzmW7jJysnGMvl6VOb/twnPO8V0HwWlKD9bKj7oEnDMB6O/5fFfOOoJopPblrUipZk5+hyGMFgwhKiSmRkCA/6vY+6k5vZw+MX44nSIBpwmiwloiJ7uE5P7vKU6eviSNMJ03uG9IqS7GncnBmyctpPkwb95yz1d0jSbVN+wKwZQ50KPqg+FW3Q/Nw71UfVYWYVciZN4cpMl8lzapSnjXOg+WaKvIqWMK5sFSohb9pS4+kSp9XU6zg56lEeotWooUQq8mw5s7mBlJKm5KLS/FpOwOJwpeFs5E2TaFlhQrGuk/XqZdf5yr0qln0xFehCmVitEbazmWHN42kXi9V5vnV9oVWoQ2mY2qCOVrWj7e0gH8pYYrYwfBzDYmbN2tRUMhWdgf+V6mtl+tnnClFzQRWtSCfrsoE6l5lTpSwLD1jT7TZXuI4dqgW/SU/vqpS1ZkWvXO0KN3km1LARheMQqYvXznX2sVEVGgTrWMi0ArebKTPse3nrwOlWdsHQ9e9vfTrH4+53jxLmL2xnq1Vf3la/btVuSnXrxPieN8R7Ta6Al8rdAO6WwxQOa+o+WN4Uj5iwMfWsPQe70xar968WBheLS3tVCBtXmDqNbY+RWeH6lRRSrp2rjX2MS646OaO5tC07n2zNxqq1nlBGpGewzOQw5zeRVY6yb3WMwjPPeK6mpWlrmYviAX+ZyqQV8Vkhq1lvhrjI7MVoDPHc5Tpbt6iHwm3/dfXsOtqKk8y9dGmBt6ra+pJ0rbckb1I//GgpY7WsiFXMMe2b6T7z2J+T+bRVQ93dBVa6vVVUpj0Bm2XY4piup+ZyUx1d1S1Djc+gtvVVcb3rVhM1xzImcIaVW2i4lg6QeyYxH02dbOKy2cqSdbaWB6xSSU8boCq+KKLb2tUOmxesPy2VqsHd0U4Dm9eTvvB8qQhed0v3q6KW9p3tvWx7Q/txTU6vtsdbZzBHF93pjXCu7Rxn2aqSxvBdcZKLnfDu/tfO+T72kDVt6PXV+6QFl/gq3Uvn2ioa36D9Nq0TG/JFZ7jNTQz3sA8r2EOP3NfXrriGr5zqAK/aYQmGpMf7ZCreA9u0zC7+rTqBznGhz1ysT8YskRe+5o63m+keRu5X4yzypA93q3Met5oBzl4Mf5fgzEPkwQddbEM6GM1LRijSx85XAPe3wXDnZcYZvO6jch3qFN+o3/8O+MALfvCEL/zgCwAAOw=="
  },
  "msg": "成功"
}

1.11. 删除访客预约

基础信息

路径: /v1/api/person/sub/delete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuidList array 是 uuid集合
  |─ string  

Body示例:

{
  "uuidList": [
    "4ce0f409692f4f2ba73adb3d04dd568b"
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─successes array 是 成功列表
    |─ string
  |─failures array 是 失败列表
    |─ string  

响应示例:

{
  "code": 0,
  "msg": "",
  "data": {
    "successes": [
      "4ce0f409692f4f2ba73adb3d04dd568b"
    ],
    "failures": []
  }
}

1.12. 修改访客预约状态

基础信息

路径: /v1/api/person/status

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是  

Body:

名称 类型 必须 默认值 备注
uuidList array 是 人员UUID集合
  |─ string
visitStatus integer 是 访客预约状态(30取消预约 40审批拒绝

Body示例:

{
  "uuidList": [
    "4ce0f409692f4f2ba73adb3d04dd568b"
  ],
  "visitStatus": 30
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否
  |─successes array 是 成功列表
    |─ string
  |─failures array 是 失败列表
    |─ string  

响应示例:

{
  "code": 0,
  "data": {
    "failures": [],
    "successes": [
      "4ce0f409692f4f2ba73adb3d04dd568b"
    ]
  },
  "msg": "成功"
}

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": "aa9c22f13f01416ebcd2d3f950796d57",
  "visitStartTimeStamp": 1678948744361,
  "visitEndTimeStamp": 1679810297000,
  "visitReason": "",
  "groupList": [
    {
      "groupUuid": "23121432421342143124312421412444"
    }
  ],
  "visitType": 1,
  "visitStatus": 20
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否  

Body:

名称 类型 必须 默认值 备注
code integer 否
msg string 否
data object 否  

响应示例:

{
  "code": 0,
  "msg": "成功"
}

results matching ""

    No results matching ""