关于使用规则,请注意:
关于接口文档,请注意:
目录 |
查询考勤配置,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchAttConfig
POST数据说明
POST数据示例如下:
{
userID:"10008817",
date:"2018-01-17"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| date | 否 | 查询历史考勤数据时必填 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": {
"longitude": "193.55544",
"latitude": "192.55",
"radius": "1",
"dateTime":"1500978167312",
"timeDatas": [
{
"id":"10000001",
"title": "上班时间08:00",
"attTime": 0,
"type":0,
"state": "",
"stateType": 2,
"startTime": 1500939000000,
"endTime": "1500942600000",
"lastTime":"10:00"
}
]
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | longitude | double | 经度 | ||
| latitude | double | 纬度 | |||
| radius | int | 半径距离(米) | |||
| dateTime | int | 当前时间的时间戳 | |||
| timeDatas | id | string | ID | ||
| title | string | 标题 | |||
| type | int | 类型 | |||
| attTime | int | 打卡时间的时间戳,0为未打卡 | |||
| state | string | 打卡状态 | |||
| stateType | int | 打卡状态类型 | |||
| startTime | int | 自动打卡开始时间的时间戳 | |||
| endTime | int | 自动打卡结束时间的时间戳 | |||
| lastTime | int | 打卡最晚时间的时间戳 | |||
查询考勤配置,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchConfig
POST数据说明
POST数据示例如下:
{
userID:"10008817",
date:"2018-01-17"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| date | 否 | 查询历史考勤数据时必填 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": {
"longitude": "192.555414",
"latitude": "29.554545",
"radius": "100",
"dateTime":"2017-07-26",
"timeDatas": [
{
"id":"10000001",
"signInTime": "08:00",
"signOutTime": "12:00",
"signInLastTime":"10:00",
"signOutLastTime":"12:30",
"autoSignInStartTime":"07:30",
"autoSignInEndTime": "8:00",
"autoSignOutStartTime": "12:00",
"autoSignOutEndTime": "12:30",
"empSignInTime": "07:28",
"empSignOutTime": "",
"signInState": "正常",
"signOutState": "",
"signInState": 0,
"signOutState": 2,
}
]
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | longitude | double | 经度 | ||
| latitude | double | 纬度 | |||
| radius | int | 半径距离(米) | |||
| dateTime | string | 当前时间 | |||
| timeDatas | id | string | ID | ||
| signInTime | string | 上班时间 | |||
| signOutTime | string | 下班时间 | |||
| signInLastTime | string | 上班打卡最晚时间 | |||
| signOutLastTime | string | 下班打卡最晚时间 | |||
| autoSignInStartTime | string | 上班自动打卡开始时间 | |||
| autoSignInEndTime | string | 上班自动打卡结束时间 | |||
| autoSignOutStartTime | string | 下班自动打卡开始时间 | |||
| autoSignOutEndTime | string | 下班自动打卡结束时间 | |||
| empSignInTime | string | 用户上班打卡时间 | |||
| empSignOutTime | string | 用户下班打卡时间 | |||
| signInState | string | 上班打卡状态 | |||
| signOutState | string | 下班打卡状态 | |||
| signInStateType | int | 上班打卡状态类型 | |||
| signOutStateType | int | 下班打卡状态类型 | |||
保存教师考勤数据,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SaveAttData
POST数据说明
POST数据示例如下:
{
userID: "10008817",
id: "10000001",
type: "0",
deviceCode:"asdsadasdasdasdasdasd"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| id | 是 | 时间区间ID |
| type | 是 | 类型 |
| deviceCode | 是 | 设备唯一编号,android传IMEI码,IOS使用uuid加keychain的方式,keychain中获取不到时就生成新的uuid并保存到keychain中 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data":{
attTime = 1500939000000,
state = "正常",
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败,2表示非常用设备 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | attTime | string | 打卡时间时间戳 | ||
| state | string | 状态 | |||
清理考勤数据,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/ClearAttData
POST数据说明
POST数据示例如下:
{
userID: "10008817"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
提交考勤审批,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SubmitAttApproval
POST数据说明
POST数据示例如下:
paramJson= {
userID: "10008817",
unitID: "10000006",
id: "10000036",
attType: 0,
submitType:0,
type:0,
date: "2017-12-14",
time: "08:20",
isHistory:0,
files: [
{
fileName: "123",
filePath: "http://oss.zjzdy.net/APP/js01.png",
fileFormat: ".png",
timeLength: "",
fileSize: "1431443",
md5code: "BBE569C30CE4161DA47C6F28917D8F0B"
}
]
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| adminUserID | 是 | 管理员ID |
| unitID | 是 | 单位ID |
| submitType | 是 | 提交类型,0正常提交,1重新提交 |
| id | 是 | submitType=0时传考勤规则ID,submitType=1时传递申请ID |
| date | 是 | 提交日期 |
| time | 否 | 异常考勤打卡时间,当type=0时必填,type=1时可以不填 |
| reason | 否 | 原因,当type=1时必填,type=0时可以不填 |
| attType | 是 | 打卡类型,0上班打卡,1下班打卡 |
| type | 是 | 审批类型,0异常考勤申请,1补卡申请 |
| fileName | 是 | 附件名称 |
| filePath | 是 | 附件路径 |
| fileFormat | 是 | 附件格式 |
| timeLength | 是 | 时间长度(视频) |
| fileSize | 是 | 文件大小 |
| md5code | 是 | md5码 |
| isHistory | 是 | 是否是历史考勤补卡,0否1是 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
审核考勤,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/CheckAttendance
POST数据说明
POST数据示例如下:
{
userID: "10008817",
id: "10000001",
state: 1
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 审批人用户ID |
| id | 是 | 需要审批的申请记录ID |
| state | 是 | 审批状态,1通过,1不通过 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
获取考勤管理员列表,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/*****/GetAttAdminUserList
GET数据说明
GET数据示例如下:
{
unitID: "10000006"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"userList":[
{
userID:"10008817",
empName:"陈张生",
photoPath:""
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| userList | userID | string | 管理员用户ID | ||
| empName | string | 管理姓名 | |||
| photoPath | string | 管理员头像 | |||
查询考勤审批列表,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchApprovalList
POST数据说明
POST数据示例如下:
{
userID:"10008817",
unitID: "10000006",
type:0,
stateType:"",
pageIndex:1,
pageSize:10
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| unitID | 是 | 单位ID |
| type | 是 | 类型,0考勤审批(对应首页DataType=15),1考勤申请(对应首页DataType=16) |
| stateType | 否 | 状态类型,"0"未审批,"1"已通过,"2"已驳回 |
| pageIndex | 是 | 页位置 |
| pageSize | 是 | 页大小 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data":[
{
id:"10000001",
title:"123123",
state:0,
content:"asdasd",
bottomText:"",
createDate:"2017-12-18 13:40:22",
rsList:
[
{
id:"10000001"
fileName: "123",
filePath: "http://oss.zjzdy.net/APP/js01.png",
fileFormat: ".png",
fileSize: "1431443",
isConverted: 1,
filePreview:"http://oss.zjzdy.net/APP/js01.png"
}
]
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| Data | id | string | id | ||
| title | string | 标题 | |||
| state | int | 状态,0未审核,1通过,2驳回 | |||
| title | string | 标题 | |||
| content | string | 内容 | |||
| bottomText | string | 底部文字 | |||
| createDate | string | 创建日期 | |||
| rsList | id | string | 资源ID | ||
| fileName | string | 附件名称 | |||
| filePath | string | 附件地址 | |||
| fileFormat | string | 附件格式 | |||
| fileSize | string | 附件大小 | |||
| isConverted | int | 是否转码 | |||
| filePreview | string | 预览地址 | |||
删除申请,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/DeleteApproval
POST数据说明
POST数据示例如下:
{
id:"10000001"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 申请ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
查询日历状态,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchCalendarStatus
POST数据说明
POST数据示例如下:
{
userID: "10008817",
unitID: "10000006",
year: 2018,
month:1
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| unitID | 是 | 单位ID |
| year | 是 | 年份 |
| month | 是 | 月份 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": {
nomalDateList:[
"2018-01-17"
],
abnomalDateList:[
"2018-01-01",
"2018-01-02"
],
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | nomalDateList | 数组 | 正常日期数组 | ||
| abnomalDateList | 数组 | 异常日期数组 | |||
查询月统计信息,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchMonthlyStatistics
POST数据说明
POST数据示例如下:
{
userID: "10008817",
unitID: "10000006",
year: 2018,
month:1
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| unitID | 是 | 单位ID |
| year | 是 | 年份 |
| month | 是 | 月份 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": {
workList:[
"2018-01-17 (星期三)"
],
missingCardList:[
"2018-01-01 (星期三) 09:00"
],
late:{
totalMinutes:60,
lateList:
[
date:"2018-01-01 (星期三) 09:00",
detail:"上班迟到1小时"
]
},
leaveEarly:{
totalMinutes:60,
leaveEarlyList:
[
date:"2018-01-01 (星期三) 18:00",
detail:"下班早退1小时"
]
},
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | workList | 数组 | 上班日期数组 | ||
| missingCardList | 数组 | 缺卡日期数组 | |||
| late | totalMinutes | int | 总迟到分钟数 | ||
| date | string | 迟到日期 | |||
| detail | string | 迟到明细 | |||
| leaveEarly | totalMinutes | int | 总早退分钟数 | ||
| date | string | 早退日期 | |||
| detail | string | 早退明细 | |||
查询非工作日考勤记录,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/SearchAttLog
POST数据说明
POST数据示例如下:
{
userID:"10008817",
date:"2018-01-17"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| date | 否 | 查询历史考勤数据时必填 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0,
"data":{
"signInTime":"2018-03-12 08:26",
"signOutTime":"2018-03-12 18:26"
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | signInTime | string | 上班打卡时间 | ||
| signOutTime | string | 下班打卡时间 | |||
记录定位不在范围内时的相关信息日志,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/WriteOutOfRangeLog
POST数据说明
POST数据示例如下:
{
userID:"XXX",
empName:"XXXX",
centerLongitude:127.115554,
centerLatitude:44.451456,
radius:200,
locateLongitude:127.111585,
locateLatitude:45.154484,
distance:50
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
| empName | 是 | 用户姓名 |
| centerLongitude | 是 | 考勤区域中心经度 |
| centerLatitude | 是 | 考勤区域中心纬度 |
| radius | 是 | 考勤区域半径 |
| locateLongitude | 是 | 定位经度 |
| locateLatitude | 是 | 定位纬度 |
| distance | 是 | 距离 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
获取教师考勤规则列表,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/*****/GetRuleList
GET数据说明
GET数据示例如下:
{
unitID:"10000006"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| unitID | 是 | 单位ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": [{
"id": "10000136",
"name": "缺省一天打卡",
"radius": "2000",
"address": "宁波研发园B区9幢5楼",
"isDisable": 0,
"isDefault": 0,
"timeList": [{
"startTime": "08:00",
"endTime": "11:05"
}, {
"startTime": "13:00",
"endTime": "15:53"
}]
},{
"id": "10000141",
"name": "学之路",
"radius": "1000",
"address": "宁波研发园B区9幢5楼",
"isDisable": 0,
"isDefault": 1,
"timeList": [{
"startTime": "08:30",
"endTime": "12:00"
}, {
"startTime": "14:00",
"endTime": "17:00"
}]
}]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | id | string | 规则ID | ||
| name | string | 规则名称 | |||
| radius | int | 考勤半径 | |||
| address | string | 地址 | |||
| isDisable | int | 是否被停用,0否,1是 | |||
| isDefault | int | 是否默认,0否,1是 | |||
| timeList | startTime | string | 上班时间 | ||
| endTime | string | 下班时间 | |||
默认状态改变,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/IsDefaultChange
POST数据说明
POST数据示例如下:
{
ruleID:"XXX",
isDefault:true
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| ruleID | 是 | 规则ID |
| isDefault | 是 | 是否默认 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
停用状态修改,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/IsDisableChange
POST数据说明
POST数据示例如下:
{
ruleID:"XXX",
isDisable:false
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| ruleID | 是 | 规则ID |
| isDisable | 是 | 是否停用,0否,1是 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
删除规则,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/*****/DeleteRule
POST数据说明
POST数据示例如下:
{
ids: "XXX,XXX"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| ids | 是 | 规则ID,多个id之间英文逗号分隔 |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error":0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
获取考勤规则明细,具体如下:
接口调用请求说明
http请求方式: GET
{WebPath}/api/*****/GetAttendanceRuleDetail
GET数据说明
GET数据示例如下:
{
id:"XXXX"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 规则ID |
返回值说明
在调用接口后,会返回JSON数据包。正常时的返回JSON数据包示例:
{
"error": 0,
"data": {
"id": "10000141",
"name": "学之路",
"allowLate": 0,
"allowLeaveEarly": 0,
"autoSignInStartMinute": 30,
"autoSignInEndMinute": 30,
"autoSignOutStartMinute": 30,
"autoSignOutEndMinute": 30,
"address": "宁波研发园B区9幢5楼",
"longitude": "121.637455",
"latitude": "29.884899",
"radius": "1000",
"earliestMinute": 0,
"latestMinute": 0,
"isDefault": 1,
"ruleDetailList": [{
"id": "10000254",
"signInTime": "08:30",
"signOutTime": "12:00",
"weekList": []
}, {
"id": "10000255",
"signInTime": "14:00",
"signOutTime": "17:00",
"weekList": []
}],
"teacherDetail": []
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | id | string | 规则ID | ||
| name | string | 规则名称 | |||
| allowLate | int | 运行迟到分钟数 | |||
| allowLeaveEarly | int | 允许早退分钟数 | |||
| autoSignInStartMinute | int | 自动签到开始分钟数 | |||
| autoSignInEndMinute | int | 自动签到结束分钟数 | |||
| autoSignOutStartMinute | int | 自动签退开始分钟数 | |||
| autoSignOutEndMinute | int | 自动签退结束分钟数 | |||
| earliestMinute | int | 最早打卡提前分钟数 | |||
| latestMinute | int | 最晚打卡延后分钟数 | |||
| address | string | 地址 | |||
| radius | int | 考勤半径 | |||
| longitude | double | 经度 | |||
| latitude | double | 纬度 | |||
| ruleDetailList | id | string | 班次明细ID | ||
| startTime | string | 上班时间 | |||
| endTime | string | 下班时间 | |||
| weekList | week | int | 星期 | ||
| teacherDetail | id | string | 人员明细ID | ||
| empName | string | 人员姓名 | |||
| deptName | string | 人员所在部门 | |||
查询学生一人脸头像数据,具体如下:
接口调用请求说明
http请求方式: POST
{WebPath}/api/FaceRecognition/GetTeacherFacePhotoByUnit
POST数据说明
POST数据示例如下:
{
"Ticket":授权码,"UnitID":授权单位ID
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Ticket | 是 | 授权码 |
| UnitID | 是 | 授权单位ID |
返回字段说明
成功:
{
"error":0,"data":[]
}
| 字段 | 类型 | 说明 | |
|---|---|---|---|
| error | int | 返回值:'0'表示成功,'1'表示失败 | |
| data | json | 人脸头像数据 | |
| message | string | error=1 返回错误信息 | |