Перейти до основного вмісту
Локація — це фізичний центр тестування, де медичні фахівці виконують забір крові. Ти використовуєш id локації для планування записів типу practitioner.
Твій API-ключ повертає лише локації в межах твого партнерського контексту доступу. Використовуй GET /api/v1/locations, щоб отримати список усіх доступних тобі локацій.
Вебхук location.* повідомляє тобі, коли локація з’являється, змінюється або зникає.

Поля

string
обов'язково
UUID локації. Передавай його як location_id під час створення запису.
string
обов'язково
Назва локації для відображення.
string
Клініка або компанія, яка керує локацією. Може бути null.
string
Назва вулиці без номера будинку. Може бути null.
string
Номер будинку. Може бути null.
string
Додатковий рядок адреси — c/o, корпус або поверх. Може бути null.
string
Місто. Може бути null.
string
Штат або провінція (визначається через пов’язаний із містом штат). Може бути null, якщо місто не має пов’язаного штату.
string
Код штату або землі за ISO 3166-2 без префікса країни (наприклад, BW для Баден-Вюртембергу). Може бути null.
string
Поштовий індекс або ZIP-код. Може бути null.
string
Повна назва країни (наприклад, Germany). Може бути null.
string
Дволітерний код країни за ISO 3166-1 alpha-2 (наприклад, DE, US). Може бути null.
string
Ідентифікатор часового поясу IANA для локації (наприклад, Europe/Berlin, America/New_York). Використовуй його, щоб показувати запланований час у правильному місцевому часі. Може бути null.
number
Широта адреси в десяткових градусах (WGS 84). Може бути null.
number
Довгота адреси в десяткових градусах (WGS 84). Може бути null.
string
Номер телефону локації. Може бути null.
string
Електронна адреса локації. Може бути null.
string
URL вебсайту локації. Може бути null.
string
Пряме посилання на локацію в Google Maps. Може бути null.
string
URL фотографії локації. Може бути null.
object
Тижневий графік роботи локації. Кожен ключ дня тижня (monday–sunday) відповідає масиву часових інтервалів { open, close } у 24-годинному форматі HH:MM. Порожній масив означає, що цього дня локація зачинена. Може бути null, якщо графік роботи локації недоступний.
string
обов'язково
Як тут проводять забір крові під час запису, якщо в записі не вказано власний draw_method: capillary (з пальця або плеча в мікроконтейнери) або venous (з вени в пробірки).
string[]
обов'язково
Способи забору крові, для яких у локації є контейнери, у відсортованому порядку. У записі тут можна вказати лише один із них як draw_method.
Завжди використовуй поле timezone, щоб переводити дату й час scheduled_at у місцевий час, перш ніж показувати їх пацієнтам або персоналу.

Доступність

Поле open_hours вище описує статичний тижневий графік роботи. Щоб показати реальні вільні слоти — і уникнути подвійного бронювання поверх наявних записів Aniva — виклич Get Availability для цієї локації та передай діапазон дат, який хочеш відобразити. Саме цей ендпоїнт є правильним джерелом істини для будь-якого інтерфейсу запису: він розгортає open_hours на сітку слотів локації, застосовує винятки для конкретних дат, віднімає вже зайняті записи та враховує мінімальний час попередження.

Роздрібні ціни

Аптека встановлює власну ціну для кожної панелі та кожного окремого біомаркера, які продає відвідувачам без попереднього запису. Ти побачиш ціну лише після того, як аптека її опублікує. List Retail Prices повертає їх для кожної локації, до якої ти маєш доступ на читання, а Get Retail Prices — для однієї локації. Обом потрібен дозвіл retail_prices_view; locations_view їх не включає. Запитуй обидва дозволи для тих самих локацій. Вебхук location.retail_prices.updated повідомляє тобі, коли змінюється ціна. location.created і location.deactivated повідомляють, коли локація з’являється або зникає. Зміна набору панелей, які пропонує локація, може надійти до тебе пізніше, ніж зміна ціни, тому повторно зчитуй List Retail Prices раз на день.

Приклад локації