1. 考勤组管理

考勤组管理


1.1. 考勤员工分页列表查询

基础信息

路径: /v1/api/attendance/group/person/list

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
orgUuid string 员工编号,支持模糊查询
personName string 员工名称,支持模糊查询
personCode string 员工编号,支持模糊查询
isOnlyAttPerson boolean false 是否仅查考勤组员工:true-仅查询考勤组员工;false-所有员工(包含考勤组内员工,默认false)
pageNum integer 1 页码,从1开始
当前页码,不传默认1
pageSize integer 20 页面大小
分页大小,不传默认20

Body示例:

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

返回数据

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
      |─groupUuid string 考勤组UUID,注:考勤组基础人员必有
      |─groupName string 考勤组名称,注:考勤组基础人员必有
      |─personUuid string 基础人员UUID
      |─personName string 基础人员姓名
      |─personCode string 基础人员编号
      |─businessType integer 0 考勤组基础人员标记:0-非考勤组员工,1-是考勤组员工

响应示例:

{
  "code":0,
  "data":{
    "list":[
      {
        "businessType":1,
        "groupName":"new",
        "groupUuid":"5ac63859e9d54242a378ddcf564bf5c7",
        "personCode":"12312",
        "personName":"eee",
        "personUuid":"aff8d7f5e79e46b3ab976d475917ad0a"
      },
      {
        "businessType":0,
        "personCode":"12345678",
        "personName":"sxk",
        "personUuid":"7d73f23434764852aefee6332b6e243c"
      }
    ],
    "pageNum":1,
    "pageSize":20,
    "total":2
  },
  "msg":"成功"
}

1.2. 考勤组分页列表查询

基础信息

路径: /v1/api/attendance/group/list

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
name string 考勤组名称 支持模糊查询
pageNum integer 1 页码,从1开始
当前页码,不传默认1
pageSize integer 20 页面大小
分页大小,不传默认20

Body示例:

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

返回数据

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 考勤组名称
      |─personCount integer 考勤组总人数

响应示例:

{
  "code":0,
  "data":{
    "list":[
      {
        "name":"new",
        "personCount":1,
        "uuid":"5ac63859e9d54242a378ddcf564bf5c7"
      },
      {
        "name":"sxk",
        "personCount":0,
        "uuid":"5d4c3ad9472b46dda57ab87ef3cbf4dd"
      }
    ],
    "pageNum":1,
    "pageSize":20,
    "total":2
  },
  "msg":"成功"
}

1.3. 考勤组详情查询

基础信息

路径: /v1/api/attendance/group/query/details

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 考勤组UUID
personCount integer 10 默认展示的人员数量

Body示例:

{
  "uuid": "5ac63859e9d54242a378ddcf564bf5c7"
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─name string 考勤组名称,查询成功时必有
  |─groupPersons array 考勤组人员信息,查询成功时必有
    |─ object
      |─personUuid string 基础人员UUID
      |─personName string 基础人员姓名(仅返回前10人)
      |─personCode string 基础人员编号(仅返回前10人)
  |─attendanceTime array 考勤时间段,查询成功时必有
    |─ object
      |─order integer 时段编号
1-时段一,2-时段二,3-时段三
      |─onSt string 上班开始时间
上班开始时间eg:09:00,需要精确到分
      |─onEt string 上班结束时间
上班结束时间eg:09:00,需要精确到分
      |─offSt string 下班开始时间
下班开始时间eg:09:00,需要精确到分
      |─offEt string 下班结束时间
下班结束时间eg:09:00,需要精确到分
      |─daySpan integer 跨天
0-正常,1-跨天
  |─specialDate array 特殊日期,设置了特殊日期且查询成功时必有
    |─ object
      |─date object 特殊日期
用于国定节假日考勤打卡调整
        |─iLocalMillis integer The local millis from 1970-01-01T00:00:00
        |─iChronology object The chronology to use in UTC.
      |─isPunch integer 是否打卡,默认不打卡:0-不打卡,1-打卡
是否打卡:0-不打卡,1-打卡
  |─weekPlan array 考勤周期LIST,查询成功时必有,注:['MONDAY','TUESDAY','WEDNESDAY','THURSDAY','FRIDAY','SATURDAY','SUNDAY']
    |─ string
  |─daySpan integer 考勤记录跨日统计选记,查询成功时必有,注:0-第一天,1-第二天
  |─personCount integer 考勤组总人数,查询成功时必有
  |─uuid string 考勤组uuid,查询成功时必有

响应示例:

{
  "code":0,
  "data":{
    "attendanceTime":[
      {
        "daySpan":0,
        "offEt":"21:42",
        "offSt":"18:42",
        "onEt":"14:49",
        "onSt":"14:46",
        "order":1
      }
    ],
    "daySpan":0,
    "groupPersons":[
      {
        "personCode":"12312",
        "personName":"eee",
        "personUuid":"aff8d7f5e79e46b3ab976d475917ad0a"
      }
    ],
    "name":"new",
    "personCount":1,
    "specialDate":[],
    "uuid":"5ac63859e9d54242a378ddcf564bf5c7",
    "weekPlan":[
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ]
  },
  "msg":"成功"
}

1.4. 更新考勤组

基础信息

路径: /v1/api/attendance/group/update

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuid string 考勤组主键UUID
name string 考勤组名称,唯一,长度2~32字符,不支持特殊字符
groupPersons array 考勤组基础人员UUID数组
  |─ string
attendanceTime array 考勤时间段
  |─ object
    |─order integer 时段编号
1-时段一,2-时段二,3-时段三
    |─onSt string 上班开始时间
上班开始时间eg:09:00,需要精确到分
    |─onEt string 上班结束时间
上班结束时间eg:09:00,需要精确到分
    |─offSt string 下班开始时间
下班开始时间eg:09:00,需要精确到分
    |─offEt string 下班结束时间
下班结束时间eg:09:00,需要精确到分
    |─daySpan integer 跨天
0-正常,1-跨天
specialDate array 特殊日期(考勤周期weekPlan的辅助设置,最多可设置32个特殊日期),作用:指定将来的某一天(或多天)是否打卡
  |─ object
    |─date object 特殊日期
用于国定节假日考勤打卡调整
      |─iLocalMillis integer The local millis from 1970-01-01T00:00:00
      |─iChronology object The chronology to use in UTC.
    |─isPunch integer 是否打卡,默认不打卡:0-不打卡,1-打卡
是否打卡:0-不打卡,1-打卡
weekPlan array 考勤周期LIST,注:['MONDAY','TUESDAY','WEDNESDAY','THURSDAY','FRIDAY','SATURDAY','SUNDAY']
  |─ string
daySpan integer 考勤记录跨天统计标志,注:0-第一天,1-第二天

Body示例:

{
  "uuid": "5b289174be624900b7220ab44a2a3892",
  "name": "修改",
  "groupPersons": [
    "aff8d7f5e79e46b3ab976d475917ad0a"
  ],
  "attendanceTime": [
    {
      "order": 1,
      "onSt": "06:01",
      "onEt": "09:01",
      "offSt": "18:01",
      "offEt": "23:58",
      "daySpan": 0
    }
  ],
  "specialDate": [
  ],
  "weekPlan": [
    "FRIDAY"
  ],
  "daySpan": 0
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

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

1.5. 创建考勤组

基础信息

路径: /v1/api/attendance/group/add

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
name string 考勤组名称,唯一,长度2~32字符,不支持特殊字符
groupPersons array 考勤组员工open IDs数组
  |─ string
attendanceTime array 考勤时间段
  |─ object
    |─order integer 时段编号
1-时段一,2-时段二,3-时段三
    |─onSt string 上班开始时间
上班开始时间eg:09:00,需要精确到分
    |─onEt string 上班结束时间
上班结束时间eg:09:00,需要精确到分
    |─offSt string 下班开始时间
下班开始时间eg:09:00,需要精确到分
    |─offEt string 下班结束时间
下班结束时间eg:09:00,需要精确到分
    |─daySpan integer 跨天
0-正常,1-跨天
specialDate array 特殊日期(考勤周期weekPlan的辅助设置,最多可设置32个特殊日期),作用:1-指定将来的某一天(或多天)是否打卡;2-创建考勤组时默认考勤组是立即生效,如果不想立即生效,可将考勤组的创建日期设置为特殊日期且不打卡即可
  |─ object
    |─date object 特殊日期
用于国定节假日考勤打卡调整
      |─iLocalMillis integer The local millis from 1970-01-01T00:00:00
      |─iChronology object The chronology to use in UTC.
    |─isPunch integer 是否打卡,默认不打卡:0-不打卡,1-打卡
是否打卡:0-不打卡,1-打卡
weekPlan array 考勤周期LIST,注:['MONDAY','TUESDAY','WEDNESDAY','THURSDAY','FRIDAY','SATURDAY','SUNDAY']
  |─ string
daySpan integer 跨天统计标记:0-第一天;1-第二天

Body示例:

{
  "name": "xinde",
  "groupPersons": [
    "aff8d7f5e79e46b3ab976d475917ad0a"
  ],
  "attendanceTime": [
    {
      "order": 1,
      "onSt": "06:00",
      "onEt": "09:00",
      "offSt": "18:00",
      "offEt": "23:59",
      "daySpan": 0
    }
  ],
  "specialDate": [
  ],
  "weekPlan": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY",
    "FRIDAY"
  ],
  "daySpan": 0
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─uuid string 考勤组open ID,添加成功时必有

响应示例:

{
  "code":0,
  "data":{
    "uuid":"5b289174be624900b7220ab44a2a3892"
  },
  "msg":"成功"
}

1.6. 批量删除考勤组

基础信息

路径: /v1/api/attendance/group/batchDelete

请求方法: POST

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
uuids array 考勤组open IDs
  |─ string

Body示例:

{
  "uuids": [
    "5d4c3ad9472b46dda57ab87ef3cbf4dd"
  ]
}

返回数据

Headers:

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

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

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

results matching ""

    No results matching ""