Katalog testů
Získat biomarker
Načíst jeden biomarker podle 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]
}
]
}
}
Vrátí jeden biomarker podle jeho číselného
id. Hodí se k převedení ID vrácených ze Seznamu panelů nebo dat termínu na úplné podrobnosti (název, jednotka, materiál, kategorie) bez procházení celého katalogu.
Obsluhuje stejný katalog jako Seznam biomarkerů, takže pošli stejný původ odběru. Archivovaný biomarker vrátí 404. Stejně tak biomarker, který nemůžeš pro daný původ odběru objednat v laboratořích, které může tvůj klíč používat.
Vyžaduje scope panels_access. Objekt pricing navíc vyžaduje scope prices_view.
Parametry cesty
Parametry dotazu
Původ odběru má jednu ze dvou podob: odběrové místo nebo domácí testovací sada. Pošli přesně jeden. Žádný nebo oba vrátí400.
- Odběrové místo
- Domácí testovací sada
Přepíše, jaký ceník
price_cents používá: retail, nebo id ceníku, který může tvůj klíč použít. Toto id vrací Získat ceník. Výchozí je ceník na fakturačním účtu tvého API klíče, jinak maloobchodní.Odpověď
Výchozí měrná jednotka. Pokud potřebuješ stabilní identitu i při přejmenování, použij
id k
dohledání v Seznamu jednotek.Kolik tento biomarker stojí a jak se prodává – viz cenové
objekty.
null je pouze tehdy, když tvému
klíči chybí scope prices_view; biomarker, který Aniva neocenila, se stále vrací s hodnotou
pricing.price_cents: null.Chybové odpovědi
| Stav | Popis |
|---|---|
400 | Chyba validace – neplatné id, chybějící nebo dva původy odběru, případně neznámý či neoprávněný rate_card. |
403 | Zakázáno – chybí scope panels_access. |
404 | Biomarker nebyl nalezen, je archivovaný nebo ho nelze pro daný původ odběru objednat. Také při neznámém location_id. |
500 | Interní chyba serveru. |
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]
}
]
}
}