---
title: "Fetch summary of the events of a scheduleable's schedules"
method: GET
path: "/calendar/summary"
tags: ["Calendars"]
---

# Fetch summary of the events of a scheduleable's schedules

`GET /calendar/summary`

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.

## Query parameters

- `around` string, required
- `consequence` 'allow' | 'first_to_arrive' | 'permit' | 'unlock', required
- `elevator_stop_id` integer
- `group_id` integer
- `lock_id` integer

## Response `200`

OK

- object
  - `events` object[]
    - `starts_at` string, date-time, required — When the interval starts
    - `ends_at` string, date-time, required — When the interval ends
  - `exceptions` object[]
    - `starts_at` string, date-time, required — When the interval starts
    - `ends_at` string, date-time, required — When the interval ends
  - `schedules_by_day` object[]
    - `date` string, date, required — The date of a day in the time interval
    - `schedule_ids` integer[], required — Ids of schedules having events on this day

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Content

---

[API](https://skmtc.dev/kisi/apis/kisi-api.md) · [All operations](https://skmtc.dev/kisi/apis/kisi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kisi/kisi-api/revisions/998700ffff5a/schema)