Catalog de teste
Obține biomarkerul
Preia un singur biomarker după 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]
}
]
}
}
Returnează un singur biomarker după
id-ul său numeric. Util pentru a transforma ID-urile returnate de Listare paneluri sau din payload-urile programărilor în detalii complete (nume, unitate, material, categorie), fără a parcurge întregul catalog.
Servește același catalog ca Listare biomarkeri, așa că trimite aceeași origine. Un biomarker arhivat returnează 404. La fel și un biomarker pe care nu îl poți comanda la acea origine cu laboratoarele pe care cheia ta le poate folosi.
Necesită scope-ul panels_access. Obiectul pricing necesită, de asemenea, scope-ul prices_view.
Parametri de cale
Parametri de interogare
Originea are una dintre cele două forme: o locație de testare sau un kit de testare la domiciliu. Trimite exact una. Lipsa originii sau trimiterea ambelor returnează400.
- Locație de testare
- Kit de testare la domiciliu
Suprascrie grila de tarife folosită de
price_cents: retail sau id-ul unei grile de tarife pe care cheia ta o poate folosi. Obținere grilă de tarife returnează acel id. Implicit se folosește grila din contul de facturare al cheii tale API, altfel cea retail.Răspuns
Unitatea de măsură implicită. Folosește
id pentru a face referire la Listare unități dacă
ai nevoie de o identitate stabilă în cazul redenumirilor.Cât costă acest biomarker și cum se vinde — vezi obiectele de
preț. Este
null doar când cheii tale îi lipsește
scope-ul prices_view; un biomarker căruia Aniva nu i-a stabilit un preț este totuși returnat, cu
pricing.price_cents: null.Răspunsuri de eroare
| Status | Descriere |
|---|---|
400 | Eroare de validare — id nevalid, nicio origine sau două origini, ori rate_card necunoscut sau neautorizat. |
403 | Interzis — lipsește scope-ul panels_access. |
404 | Biomarkerul nu a fost găsit, este arhivat sau nu poate fi comandat la acea origine. De asemenea, pentru un location_id necunoscut. |
500 | Eroare internă de server. |
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]
}
]
}
}