API开发文档 - 杏盛注册

开发说明

开发说明

功能说明：获取到考勤模块用户的考勤规则列表.
请求方式：POST（HTTPS）
请求地址： http://qwif.hbrhdl.com/qwcgi/api/checkwork/getOrgCheckRuleList.do?token=token&corpId=corpId

请求包体：

{
	"checkType":"0",
	"currentPage":"1",
	"pageSize":"100"
}

请求参数说明：

参数	说明	类型	是否必须	备注
token	用于验证	String	是
corpId	公司唯一标识	String	是
currentPage	当前版本的页数	String	是
pageSize	每页数	String	否	每页默认100
checkType	考勤类型	String	是	-1 所有规则 0 固定 1 排班 2 自由

使用说明：checkType =-1 查询所有规则 checkType =0 查询出固定规则 checkType = 1 查询排班规则 checkType =2 查询自由规则

SDK调用示例：

        //创建请求的参数
        CheckWorkRuleListVO vo = new CheckWorkRuleListVO();
        //设置获取规则类型
        vo.setCheckType("0");
        //设置获取第几页
        vo.setCurrentPage("1");
        //设置每页数量
        vo.setPageSize("100");
        //调用接口
        CheckWorkApi api = QwSdkUtil.getInter(CheckWorkApi.class);
        api.getOrgCheckRuleList(QwSdkUtil.getCacheToken(), vo);

返回结果：

{
	"code":"0",
	"data":
	{
		"currPage":1,
		"maxPage":774,
		"pageData":
		[
			{
				"address":" ",
				"area":" ",
				"checkIp":" ",
				"checkName":"resttime1",
				"checkType":"0",
				"corpId":" ",
				"countTime":" ",
				"createTime":"2022-08-26 14:27:29",
				"creater":"huanying",
				"departids":"0c61bb40c1258117fc90c2b24d3302ca|",
				"departmentName":" ",
				"departnames":" ",
				"elasticWorkHour":0,
				"endRefreshDate":" ",
				"ext1":" ",
				"ext2":" ",
				"ext3":" ",
				"groupId":" ",
				"id":"E532EC50-CFC2-4046-BF78-CC350A97E37D",
				"isCalculationWorkHour":0,
				"isElastic":" ",
				"isHaveGivens":0,
				"isManager":"1",
				"isMobileSign":" ",
				"isOutipCheck":" ",
				"isPhotographSign":0,
				"isShake":" ",
				"isUseMachineSign":"0",
				"isUseWhiteUser":0,
				"latitude":" ",
				"longitude":" ",
				"machineNames":" ",
				"monthEndDate":" ",
				"monthEndType":" ",
				"monthStartDate":" ",
				"onlySigninWorkHour":0,
				"orgId":" ",
				"overTime":0,
				"ranges":"3",
				"recordInterval":0,
				"refreshTime":" ",
				"refreshTimeType":0,
				"restTime":0,
				"ruleAddDateVoList":
				[
					{
						
					}

				],
				"ruleMinusDateVoList":
				[
					{
						
					}

				],
				"ruleVo":
				{
					
				},
				"sendTarget":" ",
				"shortName":" ",
				"signCardType":0,
				"signDetaileds":
				[
					{
						
					}

				],
				"signLen":0,
				"signNum":0,
				"signStatus":" ",
				"signTimeList":" ",
				"signinDate":0,
				"sort":0,
				"startRefreshDate":" ",
				"status":"2",
				"statusDesc":"启用",
				"strObjects":" ",
				"strWorkDates":"星期一、星期二、星期三、星期四、星期五",
				"weekDesc":" ",
				"whiteDeptIds":
				[
					"123",
					"123"
				],
				"whiteUserIds":
				[
					"123",
					"123"
				],
				"workDate":" ",
				"workDates":"1,2,3,4,5",
				"workType":0
			}

		],
		"pageSize":1,
		"totalRows":774
	},
	"desc":"成功"
}

返回参数说明：

参数	说明
maxPage	最大页数
currentPage	当前页数
totalRows	总页数

list参数	说明
address	详细地址
area	地区
checkIp	考勤ip
checkName	名称
checkType	规则类型（0：固定考勤；1：排班考勤）
corpId	公司唯一标识
countTime	总计时间
createTime	创建时间
creater	创建人
departids	部门id
departmentName	冗余的所有部门名称
departnames	部门名称
elasticWorkHour	弹性工作时长
endRefreshDate	排班规则里面结束的新考勤时间
ext1	扩展字段
ext2	扩展字段
ext3	扩展字段
groupId	分组id
id	考勤规则id
isCalculationWorkHour	是否计算考勤时长（0：不计算；1：计算）
isElastic	是否启用弹性工作时长（0：禁用；1：启用）
isHaveGivens	是否有需要发异常通知的负责人：(0:没有；1：有)
isManager	1:登陆对象为超级管理员； 2:登陆对象为普通管理员,目标对象选择是所有人，登陆对象为普通管理员，管理的也是所有人; 3:登陆对象为普通管理员,目标对象选择是所有人，登陆对象为普通管理员，但管理的是指定的几个部门; 4:登陆对象为普通管理员,目标对象选择是特定对象，登陆对象为普通管理员，但管理的是所有人; 5:登陆对象为普通管理员,目标对象选择是特定对象，登陆对象为普通管理员，管理的也是指定的几个部门。
isMobileSign	使用考勤机考勤考勤时，是否禁用手机签到(0:否：1：是)
isOutipCheck	是否允许考勤IP不包含在IP列表中签到(0：否；1：是)
isPhotographSign	是否需要拍照打卡
isShake	是否请用摇一摇（0：启用；1：禁用）
isUseMachineSign	是否使用考勤机考勤(0：否；1：是)
isUseWhiteUser	是否使用规则白名单
latitude	定点坐标纬度
longitude	定点坐标经度
machineNames	考勤机名称
monthEndDate	考勤月度范围结束日期
monthEndType	考勤月度范围结束类型(1:当月;2:次月)
monthStartDate	考勤月度范围开始日期
onlySigninWorkHour	只需上班打卡的工作时长
orgId	组织id
overTime	加班时间
ranges	目标对象类型(1:所有人;3:特定对象)
recordInterval	自由流程打卡间隔时间（分钟）
refreshTime	新考勤刷新时间
refreshTimeType	新考勤时间类型(1:当天的新考勤时间到明天的新考勤时间;2:昨天的新考勤时间到今天的新考勤时间)
restTime	休息时间
sendTarget	特定人员
shortName	简称
signCardType	打卡方式(1:上下班均打卡;2:只需上班打卡;3:自由打卡)
signLen	有多少个签到签退
signNum	签到签退数量
signStatus	总考勤状态
signTimeList	考勤时间（HH:mm-HH:mm）
signinDate	规则的第一个签到的具体时间(yyyy-MM-dd HH:mm:ss)的时间戳
sort	排序
startRefreshDate	排班规则里面开始的新考勤时间
statusDesc	状态描述
status	状态(1:草稿;2:启用)
strObjects	目标对象字符串
strWorkDates	工作日字符串
weekDesc	星期
whiteDeptIds	白名单部门
whiteUserIds	白名单人员
workDate	工作日
workType	0：工作日；1：非工作日
workDates	工作日
ruleVo	考勤规则及签到签退、增加排除日期等信息 id : 主键规则id checkName : 名称 checkIp : 考勤ip monthStartDate : 考勤月度范围开始日期 monthEndType : 考勤月度范围结束类型(1:当月;2:次月) monthEndDate : 考勤月度范围结束日期 status : 状态(1:草稿;2:发布;3:禁用) ranges : 目标对象类型(1:所有人;3:特定对象) departids : 特定部门 sendTarget : 特定人员 refreshTime : 新考勤刷新时间 area : 地区 address : 详细地址 signScope : 考勤范围 longitude : 定点坐标经度 latitude : 定点坐标纬度 creater : 创建人 createTime : 创建时间 workDates : 工作日 sort : 排序 orgId : 组织id departmentName : 特定部门名称 isShake : 是否使用摇一摇（0：启用；1：禁用） isElastic : 是否启用弹性工作时长（0：禁用；1：启用） elasticWorkHour : 弹性工作时长 restTime : 休息时间 overTime : 加班时间 isUseMachineSign : 是否使用考勤机考勤(0：否；1：是) isMobileSign : 使用考勤机考勤考勤时，是否禁用手机签到(0:否：1：是) isOutrangecheck : 是否允许考勤地址范围外可签到/签退(0：否；1：是) isHaveGivens : 是否有需要发异常通知的负责人：(0:没有；1：有) addressNum : 考勤地址数量 checkType : 规则类型（0：固定考勤；1：排班考勤；2：自由考勤） groupId : 分组id shortName : 规则简称 isOutipCheck : 是否允许考勤IP不包含在IP列表中签到(0：否；1：是) isSendDepartHead : 是否考勤异常时发送消息给部门负责人（0：否；1：是） refreshTimeType : 新考勤时间类型(1:当天的新考勤时间到明天的新考勤时间;2:昨天的新考勤时间到今天的新考勤时间) buildType : 创建类型(1:管理员创建的规则;2：系统默认的规则) signCardType : 打卡方式(1:上下班均打卡;2:只需上班打卡;3:自由打卡) onlySigninWorkHour : 只需上班打卡的工作时长 recordInterval : 打卡间隔时间 isUseWhiteUser : 是否存在白名单('0未选择1已选择') isUseRest : 是否存在休息时间段('0不存在1存在') isPhotographSign : 是否勾选拍照打卡 isManager; isCalculationWorkHour : 是否计算考勤时长（0：不计算；1：计算） signStartTime : 打卡时间范围开始时间 signEndTime : 打卡时间范围结束时间 ruleSignPosintionVoList : 考勤规则对应的签到签退（自由规则没有） ruleAddDateVoList : 考勤规则对应的增加日期（排班规则没有） ruleMinusDateVoList : 考勤规则对应的排除日期（排班规则没有） ruleAddressVoList : 考勤规则对应的考勤地址 ruleMachineVoList : 考勤规则对应的考勤机 ruleChargeGivenVoList : 考勤规则对应的考勤考勤规则负责人（自由规则没有） ruleExceptionGivenVoList : 考勤规则对应的考勤异常通知对象（自由规则没有） ruleWhiteDeptVoList : 考勤规则白名单部门 ruleWhiteUserVoList : 考勤规则白名单人员 ruleRestVoList : 考勤规则的休息时间段 humanizationSettingsPOList : 人性化设置 workTimeConstraintPO : 工时范围
signDetaileds	规则对应的签到签退及每个签到签退对应的已考勤数据 [{ signPosintionId : 规则签到时间的ID checkWorkName : 规则名称 signinTime : 规则签到时间 signType : 规则考勤类型(1:签到;2:签退) id : 用户明细数据ID SignTime : 用户签到时间"yyyy-MM-ddHH:mm" signAddress : 用户签到位置 signIp : 用户签到ip status : 用户考勤状态(1:正常;2:迟到;3:早退) content : 用户内容 longitude : 用户签到位置经度 latitude : 用户签到位置纬度 roleSort : 用户签到第几个考勤签到签退 sureSigninTime : 用户真正签到时间 lateTime : 迟到时间 leaveTime : 早退时间 abnormalTime : 迟到或早退时间 signTimeHM : 签到时间(HH:mm) pageId : 摇一摇页面唯一id machineId : 考勤打卡明细id roleAddress : 考勤规则的地址 roleLag : 考勤规则的经度 roleLat : 考勤规则的纬度 outRangeScope : 超出考勤规则多少米（整数） checkWorkId : 规则id countTime : 总计时间 isSignStartTime : 允许考勤的开始时间 isSignEndTime : 允许考勤的结束时间 signDate : 签到日期"yyyy-MM-dd" detailedSignType : 明细考勤类型 deviceNum : 手机打卡设备号 infoId : 统计记录id signStatus : 考勤总状态(1:正常；2：异常) deviceId : 考勤机id signDataType : 0:正常考勤生成的数据；1：补录生成的数据；2：判断请假时生成的数据；3：申述生成的数据；4：正常考勤时判断入职当天考勤不记录异常改过的数据 remarkPicList : 该签到签退对应的考勤明细的备注图片 picList : 考勤明细签到/退的图片 changeDetailList : 考勤明细负责人 }]
ruleAddDateVoList	考勤规则对应的增加日期（排班规则没有） [{ id : startTime：开始时间 endTime：结束时间 type：类型(1:增加的日期；2：排除的日期) checkWorkId: 考勤规则id checkWorkName: 考勤规则名称 dateType：日期类型(1:单个日期；2：日期区间) orgId: 组织id }]
ruleMinusDateVoList	考勤规则对应的排除日期（排班规则没有） [{ id : startTime：开始时间 endTime：结束时间 type：类型(1:增加的日期；2：排除的日期) checkWorkId: 考勤规则id checkWorkName: 考勤规则名称 dateType：日期类型(1:单个日期；2：日期区间) orgId: 组织id }]

企业微信

获取考勤规则列表

开发说明