天聚数行提供了丰富的API服务,其中“节假日API”是一个方便开发者查询中国法定节假日信息的强大工具。本文将详细介绍如何使用该API来获取包括节日名称类型、农历信息、上班调休情况、工资倍数、假期范围、拼假建议以及工作日相关信息等在内的数据。
接口概述
该接口支持多种查询方式,包括按年、按月、按日期范围和按多个日期批量查询。这使得开发者可以根据不同的应用场景灵活选择最适合的方式进行数据检索。
- 按年查询:例如
type=1&date=2020
。 - 按月查询:例如
type=2&date=2020-10
。 - 按日期范围查询:例如
type=3&date=2020-11-1~2020-11-10
。 - 按多个日期批量查询:例如
date=2020-10-1,2020-11-12
。
需要注意的是,无论采取哪种查询方式,单次查询所包含的总日期数不能超过31天。
请求参数详解
key
:必需,您自己的API密钥(注册账号后获得)。date
:必需,查询日期或日期范围。type
:必需,查询类型。0
代表批量查询,1
代表按年查询,2
代表按月查询,3
代表按日期范围查询。mode
:可选,默认为0
。若设置为1
,则同时返回当天有关的国内外节日信息。
返回参数解析
code
:状态码,200
表示成功。msg
:错误信息,成功时返回success
。result
:返回的结果集。date
:当前阳历日期。daycode
:日期类型,0
表示工作日,1
节假日,2
双休日,3
调休日(需上班)。isnotwork
:是否需要上班,0
为工作日,1
为休息日。wage
:薪资倍数,周末为两倍,法定节假日当天为三倍,其他为两倍。vacation
:节假日数组。remark
:调休日数组。tip
:放假提示。rest
:拼假建议。