/data/holiday
1.接口描述
该API的功能对指定年份全年节假信息进行查询
请求方式：
POST
请求URL：
https://cloudapi.deepfinch.com/data/holiday
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息，详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息，详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| year | string | 是 | 年 |
3.返回参数
正常响应 （200）
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 本次请求的 id |
| status | string | 状态。正常为 OK ，其他值表示失败。详见详见错误码 |
| result | object | 查询结果 |
其中result的字段如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| year | int | 公历年 |
| total | int | 放假日与调休工作日记录总数 |
| off_days_count | int | 放假日数量 |
| workday_adjustments_count | int | 调休工作日数量 |
| off_days | array | 放假日信息 |
| workday_adjustments | array | 调休工作日信息 |
其中off_days和workday_adjustments的字段如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| name | string | 节假日名称 |
| date | string | 放假或调休日期，格式 YYYY-MM-DD |
输出示例：
{
"request_id": "TIDee2660aceae24230a9db0bd01bdca329",
"status": "OK",
"result": {
"year": 2018,
"total": 29,
"off_days_count": 23,
"workday_adjustments_count": 6,
"off_days": [{
"date": "2018-01-01",
"name": "元旦"
},
... ...
,{
"date": "2018-10-07",
"name": "国庆节"
}],
"workday_adjustments": [{
"date": "2018-02-11",
"name": "春节"
},
... ...
,{
"date": "2018-09-30",
"name": "国庆节"
}]
}
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例：
{
"status": "RATE_LIMIT_EXCEEDED",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}