Schedules

Retrieves a list of all schedules in this project. A schedule runs scenes on a time-based calendar: when the schedule is active it applies its active_mode_ids, and when inactive it applies its inactive_mode_ids. Each mode id is a scene-mode reference that maps directly to the modes returned by the Scenes API.

GET /v1/schedules

curl https://api.novant.io/v1/schedules \
  -u ak_sample_123: \
  --compressed

Parameters

schedule_id

Optionally return only the schedule with this id, i.e.: "sch.1". Returns a 404 if no schedule with this id exists.

Returns

Returns the list of schedules in this project. If schedule_id was specified, only the selected schedule is returned.

{
  "schedules": [
    {
      "id": "sch.1",
      "name": "Business Hours",
      "schedule": "weekdays 8:00-17:00, sat 9:00-12:00",
      "active_mode_ids": [
        "sn.1.1",
        "sn.2.1"
      ],
      "inactive_mode_ids": [
        "sn.1.2",
        "sn.2.2"
      ]
    },
    ...
  ]
}

The schedule field is a string expression of calendar rules, i.e.: "weekdays 8:00-17:00, sat 9:00-12:00". See Schedules for the full grammar.

Active and Inactive Modes

active_mode_ids and inactive_mode_ids are lists of scene-mode references of the form sn.<scene>.<mode>. These ids correspond exactly to the modes ids returned by the Scenes API — resolve them there to get each mode’s name and per-point values. A scene appears at most once across the two lists.