Перейти до основного вмісту
GET
Повертає час початку доступних для бронювання слотів для однієї локації в межах запитаного періоду. Слоти формуються на основі open_hours локації з виключенням глобальних та локальних заблокованих дат і відніманням уже заброньованих записів Aniva, тож результат відображає те, що твої пацієнти можуть реально забронювати на клієнтській стороні. Потрібен дозвіл appointments_schedule. Локація також має входити до контексту доступу групи локацій твого API-ключа.
Використовуй цей ендпоїнт замість того, щоб визначати доступність за статичним полем open_hours, яке повертає Список локацій — лише цей ендпоїнт враховує актуальні записи, винятки в розкладі на окремі дати та 12-годинне мінімальне попередження у локаціях під управлінням Aniva. Кожен повернутий тут слот доступний для бронювання як є.
Відповіді містять Cache-Control: private, max-age=30, stale-while-revalidate=60, тому браузер може віддавати кешовані дані до ~30 секунд — слот, заброньований у це вікно, ще може відображатися як доступний до наступного оновлення. Обробляй конфлікти також під час бронювання.

Параметри шляху

string
обов'язково
Ідентифікатор локації (UUID). Використовуй id зі Списку локацій.

Параметри запиту

string
Включна дата початку періоду у форматі YYYY-MM-DD (інтерпретується в timezone). Необов’язковий. За замовчуванням — сьогодні, якщо не передано жодної дати, або end_date − 30 days, якщо передано лише end_date. Минулі дати автоматично обмежуються сьогоднішнім днем.
string
Включна дата кінця періоду у форматі YYYY-MM-DD (інтерпретується в timezone). Необов’язковий. За замовчуванням — сьогодні + 30 днів, якщо не передано жодної дати, або start_date + 30 days, якщо передано лише start_date. Має бути не раніше за start_date і в межах 90 днів від сьогодні.
string
Часовий пояс IANA (наприклад, Europe/Berlin), який використовується для інтерпретації start_date / end_date і групування слотів за календарними датами. Необов’язковий — за замовчуванням використовується власний часовий пояс локації. Самі часи початку слотів завжди повертаються як моменти часу в UTC (Z) і ніколи не зміщуються через цей параметр — сітка слотів завжди будується за власним часовим поясом локації; параметр впливає лише на те, до якого календарного дня потрапляє слот. Записи днів у відповіді охоплюють рівно start_date..end_date як календарні дні в цьому часовому поясі. Не передавай його, якщо не відображаєш вибір часу в іншому часовому поясі.

Відповідь

У разі успіху API повертає 200 OK з одним об’єктом доступності.
string
обов'язково
Повторений ідентифікатор локації.
string
обов'язково
Часовий пояс IANA, у якому сформовано відповідь (наприклад, Europe/Berlin) — повторює параметр запиту timezone, якщо його передано, інакше власний часовий пояс локації.
integer
Інтервал між початками сусідніх доступних слотів у хвилинах. Налаштований для локації крок сітки — кожен слот у availability потрапляє на цю сітку. null лише тоді, коли локація не має налаштувань розкладу. Не є тривалістю запису: записи з різним часом початку, що перекриваються, не конфліктують; для паралельності враховуються лише збіги точного часу початку.
array
обов'язково
Доступні для бронювання слоти по днях. Дні без жодного доступного слота пропускаються, щоб відповідь була компактною. Кожен елемент містить:

Відповіді з помилками