Skip to content

Flat calendars

Returns custom calendar periods available in the system in a flat format (one row per day). Returned data can be limited with year query parameter.

Operations

Download flat calendar as JSON

Request

GET https://api.zoined.com/v2/download/flatCalendar.json?limit=1000&offset=0&year=2018

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
yearnumber

Returns calendar period data for given year(s) only

Example:year=2018
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/flatCalendar.json?limit=1000&offset=0&year=2018' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
calendar_datestringrequired

Calendar date

Example:"2019-01-01"
calendar_yearstring

Calendar period year name

Example:"2018/2019"
period_namestring

Name of period

Example:"January"
period_numbernumber

period numeric id

Example:2
week_numbernumber

Week number of period

Example:9
seasonstring

Season name

Example:"Spring 2019"
season_labelstring

Season label

Example:"Spring"
lfl_datestring

Comparison (LFL) date last year period

Example:"2018-01-02"
bank_holiday_namestring

Bank holiday name

Example:"New Year"
Response
{
  "calendar_date": "2019-01-01",
  "calendar_year": "2018/2019",
  "period_name": "January",
  "period_number": 2,
  "week_number": 9,
  "season": "Spring 2019",
  "season_label": "Spring",
  "lfl_date": "2018-01-02",
  "bank_holiday_name": "New Year"
}