Каталог тестов
Получить биомаркер
Получить один биомаркер по ID
GET
/
api
/
v1
/
biomarkers
/
{id}
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}
Возвращает один биомаркер по его числовому
id. Удобно, чтобы получать полные данные (название, единица измерения, материал, категория) по ID из Списка панелей или данных записи, не перебирая весь каталог.
Он использует тот же каталог, что и Список биомаркеров, поэтому передавай тот же источник. Для архивного биомаркера вернётся 404. То же самое — для биомаркера, который нельзя заказать для этого источника в лабораториях, доступных твоему ключу.
Требуется область доступа panels_access. Для объекта pricing также требуется область доступа prices_view.
Параметры пути
Параметры запроса
Источник может быть одного из двух видов: локация для сдачи анализов или набор для домашнего теста. Передай ровно один. Если не передать ни одного или передать оба, вернётся400.
- Локация для сдачи анализов
- Набор для домашнего теста
Переопределяет тарифную карту для
price_cents: retail или id тарифной карты, доступной твоему ключу. Этот id возвращает Получить тарифную карту. По умолчанию используется карта из платёжного аккаунта твоего API-ключа, иначе — розничная.Ответ
Единица измерения по умолчанию. Используй
id для сопоставления со Списком единиц измерения, если
нужен стабильный идентификатор при переименованиях.Сколько стоит этот биомаркер и как он продаётся — см. объекты
цен.
null только, если у твоего ключа нет
области доступа prices_view; биомаркер, для которого Aniva не установила цену, всё равно
возвращается с pricing.price_cents: null.Ответы с ошибками
| Статус | Описание |
|---|---|
400 | Ошибка валидации — неверный id, не указан источник или указаны оба, либо неизвестная или недоступная rate_card. |
403 | Доступ запрещён — отсутствует область доступа panels_access. |
404 | Биомаркер не найден, находится в архиве или его нельзя заказать для этого источника. Также при неизвестном location_id. |
500 | Внутренняя ошибка сервера. |
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}
⌘I
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}