Katalog badań
Pobierz biomarker
Pobierz pojedynczy biomarker według 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]
}
]
}
}
Zwraca pojedynczy biomarker na podstawie jego numerycznego
id. Przydatne do zamiany identyfikatorów zwracanych przez Lista paneli lub w danych wizyty na pełne szczegóły (nazwa, jednostka, materiał, kategoria) bez przeszukiwania całego katalogu.
Obsługuje ten sam katalog co Lista biomarkerów, więc wyślij to samo źródło pobrania. Zarchiwizowany biomarker zwraca 404. To samo dotyczy biomarkera, którego nie możesz zamówić dla tego źródła w laboratoriach dostępnych dla twojego klucza.
Wymaga zakresu panels_access. Obiekt pricing wymaga dodatkowo zakresu prices_view.
Parametry ścieżki
Parametry zapytania
Źródło pobrania ma jedną z dwóch form: punkt pobrań lub domowy zestaw testowy. Wyślij dokładnie jedną. Brak lub wysłanie obu zwraca400.
- Punkt pobrań
- Domowy zestaw testowy
Nadpisz cennik używany przez
price_cents: retail lub id cennika dostępnego dla twojego klucza. To id zwraca Pobierz cennik. Domyślnie używany jest cennik przypisany do konta rozliczeniowego twojego klucza API, a w przeciwnym razie detaliczny.Odpowiedź
Domyślna jednostka miary. Użyj
id do powiązania z Listą jednostek,
jeśli potrzebujesz stałej identyfikacji mimo zmian nazw.Ile kosztuje ten biomarker i jak jest sprzedawany — zobacz obiekty
cenowe.
null wyłącznie, gdy twój klucz nie
ma zakresu prices_view; biomarker niewyceniony przez Aniva nadal jest zwracany, z
pricing.price_cents: null.Odpowiedzi z błędami
| Status | Opis |
|---|---|
400 | Błąd walidacji — nieprawidłowe id, brak źródła pobrania lub podane dwa źródła, albo nieznany lub nieautoryzowany rate_card. |
403 | Brak dostępu — brak zakresu panels_access. |
404 | Nie znaleziono biomarkera, został zarchiwizowany lub nie można go zamówić dla tego źródła pobrania. Również nieznane location_id. |
500 | Wewnętrzny błąd serwera. |
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]
}
]
}
}