跳转到主要内容
POST
查询日历事件列表

限制说明

使用说明

  • year 默认为当前年份;不传 month 时返回整年,传 day 时必须同时传 month。
  • items 合并了日历自有事件(ID 为 cale.*)、设置了 workdays 时按非工作日逐日生成的 non_work.YYYYMMDD 条目,以及关联节假日日历的事件;total 统计全部条目。
  • days 给出范围内每一天的判定结果。
  • 仅支持个人日历(cal_id 以 cal. 开头),其他 ID 返回 InvalidParameter。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

日历事件列表请求。day > 0 时必须同时指定 month;month 与 day 为 0 表示不过滤。

cal_id
string
必填

日历 ID,可通过 POST /calendar/list 获取;该接口以 kind = exchange.holiday 返回的交易所日历 ID 同样可用,因此规则可直接读取交易所日历。

year
integer

年份,留空时默认当前年。

必填范围: x >= 2023
month
integer

月份(1-12),0 表示不按月过滤。

必填范围: 0 <= x <= 12
day
integer

日(1-31),0 表示不按日过滤。

必填范围: 0 <= x <= 31

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

日历事件列表响应。