更新日期:     浏览次数:

1. 签到数据

通过本页接口,企业开发者可以获得企业在云之家的签到数据。

1.1. 授权说明

云之家获取签到记录接口都需要通过云之家OAuth2.0授权协议进行授权,授权级别为resGroupSecret级,授权方式为在接口请求URL后面添加accessToken参数,例如https://www.yunzhijia.com/gateway/openimport/open/...?accessToken=xxxxxx

1.2. 网络传输协议

HTTPS

1.3. 请求地址

https://www.yunzhijia.com

1.4. 获取签到记录

1.4.1. 获取代签到数据

URL:/gateway/attendance-data/v1/clockIn/listReplaceClockIn?accessToken=xxxxxxxxx

HTTP请求方法: POST

HTTP内容类型Content-Type: application/x-www-form-urlencoded

输入参数:

参数名 数据类型 是否必传 说明
workDateFrom String 开始时间 (格式:yyyy-MM-dd)
workDateTo String 结束时间 (格式:yyyy-MM-dd)
start Integer 开始页(默认第一页从1开始)
limit Integer 每页显示条数大小(默认页大小为 :200>=size>=10)
eid String 工作圈ID

输出结果:

{
    "data": [
        {
            "deptName": "研发部",//部门信息  
            "number": 1,//序号
            "masterUserName": "张三",//设备拥有人姓名(张三)
            "openId": "xxxxx",//打卡用户openId
            "remark": "xxxxxxx",//备注 例如:张三疑似为李四代签到了
            "clockInAddress": "xxxxxxx",
            "userName": "李四",//用户名(李四)
            "day": 1571925335478, //签到日期 
            "deviceId": "xxxxxx",//设备编号
            "clockInTime": 1571925335478 //签到时间为毫秒数
        }
    ],
    "success": true, // true/false
    "code": //响应码
}

1.4.2. 获取移动签到明细

获取移动签到明细新接口,该接口从公布日起(2017-02-24)开始提供查询移动签到数据服务。

URL:/gateway/attendance-data/v1/clockIn/list?accessToken=xxxxxxxxx

HTTP请求方法: POST

HTTP内容类型Content-Type: application/x-www-form-urlencoded

输入参数:

参数名 数据类型 是否必传 说明
workDateFrom String 查询考勤打卡记录的起始时间 (格式:yyyy-MM-dd)
workDateTo String 查询考勤打卡记录的结束时间 (格式:yyyy-MM-dd)
start Integer 开始页(默认第一页从1开始)
limit Integer 每页显示条数大小(默认页大小为 :200>=size>=10)
eid String 团队ID
openIds String 查询指定员工ID (最大不能超过50,多个中间用 , 号隔开)

输出结果:

{
    "data": [
        {
            "position": String, //签到地点
            "bssid": String, //无线接入点的MAC地址
            "ssid": String,//无线网络名称
            "day": String, //签到日期 (格式:yyyy-MM-dd)
            "time": long, //签到时间 (毫秒数)
            "openId": String, //签到人员编号
            "positionResult": String, //签到位置结果(Normal:范围内;Outside:范围外)
            "approveResult": { //签到审核结果
                "approveId": String, //关联的审批ID
                "approveUserOpenId": String, //签到审核用户ID
                "approveTime": long, //审批时间
                "approveStatus": String, //审批状态 (未处理:UNHANDLED、已知悉:KNOWEN、已处理:HANDLED)
                "approveType": String //签到审批类型 (外勤反馈:OUTWORK、异常反馈:EXCEPTION、迟到:LATE、早退:EARLYLEAVE、缺勤:ABSENCE)
            }
     "department": String, //部门名称
            "userName": String, //用户名
            "photoId": String, //签到拍照文件ID
            "remark": String, //签到备注
        }
    ],
    "total": long, //签到流水数据总数
    "success": boolean, //成功标识 true/false
    "errorMsg": String, //异常信息
    "errorCode": String //异常代码
}

1.4.3. 按具体日期查询签到明细

URL:/gateway/attendance-data/v1/clockIn/day/list?accessToken=xxxxxxxxx

HTTP请求方法: POST

HTTP内容类型Content-Type: application/x-www-form-urlencoded

输入参数:

参数名 数据类型 是否必传 说明
eid String 团队id
day String 查询日期, 格式如 2017-01-02
start Integer 查询页数, 默认为第一页,即 start为1
limit Integer 查询数量, 最大200条数据
openIds String 指定查询用户openId, 以逗号分隔

输出结果:

{
    "data": [
        {
            "position": String, //签到地点
            "bssid": String, //无线接入点的MAC地址
            "ssid": String,//无线网络名称
            "day": String, //签到日期 (格式:yyyy-MM-dd)
            "time": long, //签到时间 (毫秒数)
            "openId": String, //签到人员编号
            "positionResult": String, //签到位置结果(Normal:范围内;Outside:范围外)
            "approveResult": { //签到审核结果
                "approveId": String, //关联的审批ID
                "approveUserOpenId": String, //签到审核用户ID
                "approveTime": long, //审批时间
                "approveStatus": String, //审批状态 (未处理:UNHANDLED、已知悉:KNOWEN、已处理:HANDLED)
                "approveType": String //签到审批类型 (外勤反馈:OUTWORK、异常反馈:EXCEPTION、迟到:LATE、早退:EARLYLEAVE、缺勤:ABSENCE)
            }
     "department": String, //部门名称
            "userName": String, //用户名
            "photoId": String, //签到拍照文件ID
            "remark": String, //签到备注
        }
    ],
    "total": long, //签到流水数据总数
    "success": boolean, //成功标识 true/false
    "errorMsg": String, //异常信息
    "errorCode": String //异常代码
}

1.5. 上传签到数据

1.5.1. 获取一个人可以打卡的地点列表

url: /gateway/attendance-data/v1/attSet/getUserPositionList?accessToken=xxxxxxxxx

说明:本接口获取的positionId 只适用于当前openId 用户,其他用户不可共用。

HTTP请求方法: POST

HTTP内容类型Content-Type: application/json

输入:

{
    "openId":"xxxx" //用户编号,必填
}

输出:

    {
         "success":boolean, //成功标识 true/false
         "resultCode":Integer, //异常代码
         "error":String,//异常信息
         "data":
         {
             "attSets":
             [
                 {
                     "position":String, //签到点名称
                     "positionId":String, //签到点编号
                     "lng":Double,//经度
                     "lat":Double //纬度
                 }
             ]
         }
    }

1.5.2. 单条打卡记录上传

url: /gateway/attendance-data/v1/clockIn/singleUpload?accessToken=xxxxxxxxx

HTTP请求方法: POST

HTTP内容类型Content-Type: application/json

输入:

{
    "openId":"xxxx", //用户编号,必填
    "clockType":1, //1内勤,必填
    "clockInTime":1532501437000, // 考勤时间,毫秒数,必填
    "positionId":"xxxxx", //考勤点编号,必填
    "remark":"xxxx" //备注,非必填
}

输出:

{
        "success":true, //成功标识 true/false
        "error":"",//异常信息
        "resultCode":200, //异常代码
        "data":{
            "success":{
                "count":1 //成功数量
            }
        }
     }

1.5.3. 多条打卡记录上传 (最多一次性200条数据)

url: /gateway/attendance-data/v1/clockIn/mutiUpload?accessToken=xxxxxxxxx

HTTP请求方法: POST

HTTP内容类型Content-Type: application/json

输入:

[
    {
        "index":1, //保证每一次调用的唯一性,必填
        "openId":"xxxxx", //用户编号,必填
        "clockType":1, //1内勤,必填
        "clockInTime":1532501437000, // 考勤时间,毫秒数,必填
        "positionId":"xxxx", //考勤点编号,必填
        "remark":"xxx" //备注,非必填
    },
    {
        "index":2, //保证每一次调用的唯一性,必填
        "openId":"xxxx", //用户编号,必填
        "clockType":1, //1内勤,必填
        "clockInTime":1532501437000, // 考勤时间,毫秒数,必填
        "positionId":"xxx", //考勤点编号,必填
        "remark":"xxx" //备注,非必填
    }
]

输出:

{
    "success":true, //成功标识 true/false
    "error":"xxxx",//异常信息
    "resultCode":200,  //异常代码
    "data":{
        "success":{
            "count":1 //处理成功数量
        },
        "failure":{
            "count":1, //处理失败数量
            "details":[
                {
                    "index":1, //处理失败数据的编号
                    "errorCode":"xxxxxxxxx" //处理失败编码
                }
            ]
        }
    }
}

1.6. FAQ

暂无

results matching ""

    No results matching ""