Catàleg de proves
Obtén un biomarcador
Obtén un únic biomarcador per 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]
}
]
}
}
Retorna un únic biomarcador pel seu
id numèric. Útil per resoldre els ID retornats per Llistar panells o per les càrregues útils de les cites en detalls complets (nom, unitat, material, categoria) sense recórrer tot el catàleg.
Serveix el mateix catàleg que Llistar biomarcadors, així que envia el mateix origen. Un biomarcador arxivat retorna 404. També ho fa un biomarcador que no pots demanar en aquest origen amb els laboratoris que la teva clau pot fer servir.
Requereix l’àmbit panels_access. L’objecte pricing també requereix l’àmbit prices_view.
Paràmetres de ruta
Paràmetres de consulta
L’origen té una de dues formes: un centre de proves o un kit de prova a casa. Envia’n exactament un. Cap dels dos o tots dos retorna400.
- Centre de proves
- Kit de prova a casa
Substitueix la taula de tarifes que utilitza
price_cents: retail, o l’id d’una taula de tarifes que la teva clau pugui fer servir. Obtenir taula de tarifes retorna aquest id. Per defecte fa servir la taula del compte de facturació de la teva clau d’API; si no, la de venda al públic.Resposta
Unitat de mesura per defecte. Fes servir
id per resoldre-la amb Llistar unitats si
necessites una identitat estable tot i els canvis de nom.El que costa aquest biomarcador i com es ven — consulta els objectes de
preu. És
null només quan la teva clau no té
l’àmbit prices_view; un biomarcador al qual Aniva no ha posat preu es retorna igualment, amb
pricing.price_cents: null.Respostes d’error
| Estat | Descripció |
|---|---|
400 | Error de validació — id no vàlid, cap origen o dos orígens, o rate_card desconegut o no autoritzat. |
403 | Prohibit — manca l’àmbit panels_access. |
404 | Biomarcador no trobat, arxivat o que no es pot demanar a l’origen. També per a un location_id desconegut. |
500 | Error intern del servidor. |
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]
}
]
}
}