Каталог тестів
Отримати біомаркер
Отримати один біомаркер за 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. Зручно для перетворення ідентифікаторів зі Списку панелей або даних запису на повну інформацію (назва, одиниця вимірювання, матеріал, категорія) без перегляду всього каталогу.
Використовує той самий каталог, що й Список біомаркерів, тому передавай те саме джерело забору. Архівований біомаркер повертає 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]
}
]
}
}