跳转到主要内容
POST
查询服务日历列表

限制说明

使用说明

  • 不传 kind 时返回个人日历。region.official.holiday 与 exchange.holiday 返回共享日历(公共节假日,以及时区为交易所时区的交易日历),默认按调用方语言区域过滤,no_locale 为 true 时不过滤;节假日日历的 cal_id 可填入 extra_cal_ids,交易所日历的 cal_id 可直接在规则中引用。
  • 列表不分页,total 等于返回的条目数。

授权

app_key
string
query
必填

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

请求体

application/json

日历列表请求。kind 用于按类型过滤;no_locale 在查询公共节假日日历时关闭 locale 过滤。

kind
enum<string>

日历类型过滤条件,为空时默认 personal。region.official.holiday 查询地区法定假日公共日历(按调用方 locale 过滤);exchange.holiday 查询共享的交易所休市日历,规则可直接读取其 cal_id;personal 查询账户自建日历。

可用选项:
region.official.holiday,
exchange.holiday,
personal
no_locale
boolean

查询公共节假日日历时关闭 locale 过滤。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

日历列表响应。