FAfalconchristmas
fppd

Expand the schedule over an arbitrary date range.

Changed on

Unlike /api/fppd/schedule, which reports only the rolling window fppd has actually scheduled out, this expands the configured schedule rules across any requested range so past and future dates can be previewed. Occurrences are advisory - they describe what the schedule says should happen, not what fppd has committed to running.

get/api/fppd/schedule/range

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/fppd/schedule/range
  • Auth
    none declared

Query parameters

startinteger

Range start as epoch seconds.

endinteger

Range end as epoch seconds. Must be after start and no more than 420 days later.

includeDisabledboolean

Set to 1 to also expand disabled schedule entries.

summaryboolean

Set to 1 to collapse to one item per schedule entry per day, each carrying a count of that day's occurrences. Intended for month and other coarse views, where a repeating entry would otherwise return thousands of items.

Response

Object with a schedule member containing entries, items, rangeStart and rangeEnd.

Changes