Перейти к основному содержанию
GET
Получи список заказов наборов для домашнего теста. Заказ набора для домашнего теста отправляет почтой тестовый набор для самостоятельного сбора — Aniva высылает набор, пациент сам собирает образец дома и отправляет его обратно по почте. Каждый заказ набора для домашнего теста включает встроенный профиль пациента. Если передан profile_id, возвращает все заказы наборов для домашнего теста для этого профиля. Если не указан, возвращает все доступные заказы наборов для домашнего теста. Требуется разрешение home_kit_orders_view или home_kit_orders_manage.

Запрос

Параметры запроса

string
Фильтр по UUID профиля. Если указан, возвращаются все заказы наборов для домашнего теста для этого профиля.
string
Фильтр по лабораторному коду (точное совпадение) — найди заказ по коду, напечатанному на физическом наборе в руках, например перед вызовом Активировать.

Ответ

При успехе API возвращает 200 OK с массивом объектов заказов наборов для домашнего теста.
string
обязательно
Уникальный идентификатор заказа набора для домашнего теста (UUID).
string
обязательно
UUID профиля, которому принадлежит этот заказ набора для домашнего теста.
string
обязательно
Текущий статус заказа набора для домашнего теста. Одно из значений: pending, dispatched, activated или cancelled. Детализация готовности лабораторных результатов определяется через Получить результаты.
object
обязательно
Адрес доставки набора — один из двух форматов: либо { location_id } со ссылкой на известную локацию тестирования, либо поля встроенного адреса (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email необязательны — те же поля, что и в API локаций). Укажи ровно один вариант — ссылку на локацию или встроенный адрес, но не оба сразу.
string
Лабораторный код образца, под которым приходят результаты — напечатан на физическом наборе, его пациент считывает с коробки как код активации. null, пока набор не упакован. Только для чтения.
string
обязательно
Метка времени сбора образца, переданная через Активацию — когда пациент собрал образец. null, пока набор не активирован.
string
Заказ набора для домашнего теста, который заменяется этим, если это набор на замену. null для обычного заказа. См. Создание заказа набора для домашнего теста.
string
Причина отправки замены. null для обычного заказа.
string[]
обязательно
Адреса в нижнем регистре, на каждый из которых приходит одно письмо, когда все результаты лаборатории готовы. Пустой список, если отключено. См. Письма о готовности результатов.
object
обязательно
Заданные партнёром пары ключ/значение, возвращаемые без изменений. Всегда присутствует — {}, если не задано.
string
обязательно
Метка времени создания заказа набора для домашнего теста в формате ISO 8601.
string
Временная метка последнего обновления в формате ISO 8601. Может быть null.
object
обязательно
Профиль пациента, связанный с этим заказом набора для домашнего теста.
HomeKitOrderPanel[]
обязательно
Панель, прикреплённая к этому заказу набора для домашнего теста, — всегда ровно одна (набор для домашнего теста соотносится 1:1 с физическим набором), её можно заменить через Обновить, пока статус pending. Подробности о панели (название, биомаркеры) смотри через Список панелей.
HomeKitOrderIndividualBiomarker[]
обязательно
Отдельные биомаркеры, прикреплённые к этому заказу набора для домашнего теста вне какой-либо панели. Сопоставь каждый biomarker_id со Списком биомаркеров с home_kit=true, чтобы получить данные для отображения.
HomeKitOrderShipmentLink[]
обязательно
Посылки, связанные с этим заказом набора для домашнего теста, от самой старой к новой — обычно набор к пациенту и образец обратно в лабораторию. Пусто, пока фулфилмент не распечатает этикетку. Полные данные по посылкам получи через Список отправлений с ?home_kit_order_id=.

Повторные вызовы

Aniva хранит ответ этого эндпоинта 5 минут для каждого API-ключа. Повторный запрос в течение этого времени получает сохранённый ответ. Заголовки Cache-Status и Age показывают, что ответ сохранён, и как давно он получен. Чтобы узнавать об изменениях сразу, подпишись на события вебхуков home_kit_order.created и на событие каждого статуса, например home_kit_order.activated. См. Повторные запросы.

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