Перейти к основному содержанию
GET
Возвращает доступное для записи время начала слотов для одной локации в запрошенном интервале. Слоты формируются на основе open_hours локации за вычетом глобальных и локальных заблокированных дат, а также уже оформленных записей Aniva, поэтому результат отражает слоты, которые твои пациенты действительно могут забронировать на стороне клиента. Требуется scope 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) — повторяет query-параметр timezone, если он был передан, иначе используется собственный часовой пояс локации.
integer
Интервал между соседними доступными временами начала слотов в минутах. Шаг сетки, настроенный для локации — каждый слот в availability попадает на эту сетку. Равно null, только если для локации не настроено расписание. Не является длительностью записи: пересекающиеся записи с разным временем начала не конфликтуют; при расчёте одновременной загрузки учитываются только совпадения точного времени начала.
array
обязательно
Доступные для записи слоты по дням. Дни без доступных слотов не включаются, чтобы ответ оставался компактным. Каждый элемент содержит:

Ответы с ошибками