Sign in
Calendars

Fetch summary of the events of a scheduleable's schedules

The summary of a given general time interval (the "window") for a given scheduleable (e.g. a specific door) consists of three parts:

  • The effective time intervals within the window when the scheduleable is under the effect of the consequence. This is calculated as the difference of the regular and the exception events.
  • The exceptions time intervals within the window overriding events generated by regular schedules
  • The schedules by day for the window.

Where:

  • Events are generated by the scheduleable's non-override schedules.
  • Exceptions are generated by the scheduleable's override schedules.

Please note that you have to pass in either an elevator_stop_id, a group_id, or a lock_id to be used as the scheduleable.

get/calendar/summary

Query parameters

aroundstring required

The time range to scope the summary. The timestamp is expected to be in ISO8601 format.

Supported patterns:

  • Start/End, eg. 2019-03-09T13:00:00Z/2019-03-10T15:30:00Z
  • Start/Duration, eg. 2019-03-09T13:00:00Z/P1Y2M10D
  • Duration/End, eg. PT2H30M/2019-03-09T15:30:00Z

Duration on its own (eg. P1Y2MT1H) is not supported.

consequence'allow' | 'first_to_arrive' | 'permit' | 'unlock' required

Filter by consequence

elevator_stop_idinteger

Filter by the id of the scheduled elevator stop

group_idinteger

Filter by the id of the scheduled group

lock_idinteger

Filter by the id of the scheduled lock

Response

OK

Changes

No recorded changes to this endpoint across all 1 revision of this API.