TimeSelector

name
Type: string
required
time_selector_entries
Type: array object[]

Time Selector Entries define when a Time Selector is active. A Time Selector can have 0..N Entries, and any of them being active will result in the Time Selector being active at a given time.

When a Time Selector Entry is compared against a provided local date-time, the date component ({start|end}_{year|month|day} fields) is checked first. These fields are interpreted differently depending on whether an Entry is Continuous or a Block. Next, the time is checked to make sure it is in the desired range optionally set by the {start|end}_time fields. Lastly, the Entry can be made valid on only certain days of the week by setting the on_{day} fields.
- type
  Type: stringenum
  required
  
  The time selection entry may be either a "block" where year, month, and/or day ranges may be specified (e.g. every December, 1st-25th days), or "continuous" where the selection will be valid between a start and end date (e.g. 1/1/2022-12/31/2022).
  
  values
  continuous
  block
- end_day
  Type: integer
  
  Integer numbers.
- end_month
  Type: integer
  
  Integer numbers.
- end_time
  Type: stringFormat: time
- end_year
  Type: integer
  
  end_{year|month|day} fields are all required and interpreted as a full date for "continuous" entries. For "block" entries, these are optional and checked separately, and all {years|months|days} including and before the one specified will be considered.
- on_friday
  Type: boolean
- on_monday
  Type: boolean
  
  on_{day} fields determine whether or not the time selection will apply on the particular day of the week. All days will apply (true) if none of the fields are specified.
- on_saturday
  Type: boolean
- on_sunday
  Type: boolean
- on_thursday
  Type: boolean
- on_tuesday
  Type: boolean
- on_wednesday
  Type: boolean
- start_day
  Type: integer
  
  Integer numbers.
- start_month
  Type: integer
  
  Integer numbers.
- start_time
  Type: stringFormat: time
  
  {start|end}_time fields are RFC3339 style Times of the Day without time zone or date components, and can be used to specify a window of time on an otherwise applicable day that a time selection will apply.
- start_year
  Type: integer
  
  start_{year|month|day} fields are all required and interpreted as a full date for "continuous" entries. For "block" entries, these are optional and checked separately, and all {years|months|days} including and after the one specified will be considered.