Custom calendars

Returns custom calendar periods available in the system. Returned data can be limited with year and period query parameters.

Operations

Download custom calendar as JSON

Request

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

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

periodstring

Returns calendar period data for given period type(s) only

Example:period=season

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

Responses

Request has been processed successfully.

Headers

Content-Type: application/json

Bodyapplication/json

period_keystringrequired

Period type identifier

Example:"season"

period_yearnumberrequired

Period year

Example:2018

period_namestringrequired

Name of period

Example:"Autumn Season"

period_numbernumberrequired

period numeric id

Example:2

start_datestringrequired

Start date of period

Example:"2018-07-01"

end_datestringrequired

End date of period

Example:"2018-12-31"

Response

{
  "period_key": "season",
  "period_year": 2018,
  "period_name": "Autumn Season",
  "period_number": 2,
  "start_date": "2018-07-01",
  "end_date": "2018-12-31"
}