北森 API

获取加班数据

POST

/AttendanceOpen/api/v1/AttendanceOvertime/GetOverTimeList

接口限制：100次/秒/企业 3000次/分钟/企业

适用场景：根据加班时间获取加班数据

警告信息：-

tips：同步执行，查询页位置从1开始，每次查询数量默认100条，最多5000条

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://openapi.italent.cn/AttendanceOpen/api/v1/AttendanceOvertime/GetOverTimeList' \
--header 'Content-Type: application/json' \
--data-raw '{
	"OverTimeDate": "2020-11-11 11:10:20"
}'

响应示例

{
    "Data": {
        "OverTimeList": [
            {
                "StaffId": 0,
                "StaffEmail": "string",
                "StdOrganization": 0,
                "StartDate": "2019-08-24T14:15:22Z",
                "StopDate": "2019-08-24T14:15:22Z",
                "ActualStartDateTime": "2019-08-24T14:15:22Z",
                "ActualStopDateTime": "2019-08-24T14:15:22Z",
                "ActualDurationConversion": "string",
                "Type": "string",
                "Compensation": "string",
                "Reason": "string",
                "DocumentType": 0,
                "ApproveStatus": "string",
                "PointStartDateTime": "2019-08-24T14:15:22Z",
                "PointStopDateTime": "2019-08-24T14:15:22Z",
                "PointApproveStatus": "string",
                "ContrastState": 0,
                "ComparePointStartDateTime": "2019-08-24T14:15:22Z",
                "ComparePointStopDateTime": "2019-08-24T14:15:22Z",
                "ClockRule": 0,
                "StopPointRange": 0,
                "Initiator": 0,
                "InitiatorEmail": "string",
                "CreatedTime": "2019-08-24T14:15:22Z",
                "ModifiedTime": "2019-08-24T14:15:22Z",
                "PointInitiator": 0,
                "PointInitiatorEmail": "string",
                "PointTime": "2019-08-24T14:15:22Z",
                "Properties": {
                    "property1": {},
                    "property2": {}
                },
                "OverTimeDuration": 0,
                "OverTimeDurationIncludeUnit": "string",
                "OId": "string"
            }
        ],
        "Total": 0
    },
    "Code": "Succeed",
    "Message": "string"
}

请求参数

Body 参数application/json

OverTimeDate

string <date-time>

必需

加班日期示例格式“2020-11-11 11:10:20”

PageIndex

integer <int32>

页码默认1

可选

PageSize

integer <int32>

可选

每页数量默认100 最高设置300

示例

返回响应

🟢200OK

application/json

Body

Data

object

可选

OverTimeList

array [object {32}]

可选

Total

integer <int32>

可选

数据总量，如：100

Code

enum<string>

可选

返回状态编码
200 成功
206 部分成功
401 无权限
417 失败

枚举值:

SucceedPartSucceedNoPermissionFailed

Message

string

错误信息

可选

通过UserId获取假期余额数据

将加班数据推送至北森系统