Skip to main content

TimeAxis

How a TIME_DIARY_EDGE axis splits the day. Send either explicit ranges, or step with from and to. When ranges is not empty it is used and the step fields are ignored. Responses always use the explicit form.

modestring

Informative: the mode is inferred from the fields sent (ranges, or step with from and to), so this value is not read.

Possible values: [byStep, explicit]

stepinteger<int32>

Slot length in minutes: a positive integer. Take it from time.allowedStepsRanges in the reach-capabilities response; other positive values are accepted too. The last slot is shorter when the span is not a multiple of step.

fromstring

Start of the split, in HH:mm. Used with step and to. Send a valid HH:mm: a malformed value is not rejected with a 400.

tostring

End of the split, in HH:mm (24:00 is allowed). Used with step and from. When it is earlier than from, the split continues past midnight; equal values cover the whole day.

ranges object[]

Explicit slots. When not empty, they are used and step, from and to are ignored.

  • Array [
  • fromstring

    Start of the slot, in HH:mm.

    tostring

    End of the slot, in HH:mm.

  • ]
  • TimeAxis
    {
    "mode": "byStep",
    "step": 0,
    "from": "string",
    "to": "string",
    "ranges": [
    {
    "from": "string",
    "to": "string"
    }
    ]
    }