Testcatalogus
Biomarker ophalen
Haal één biomarker op via 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]
}
]
}
}
Geeft één biomarker terug op basis van het numerieke
id. Handig om de ID’s uit Panels weergeven of afspraak-payloads om te zetten naar volledige details (naam, eenheid, materiaal, categorie) zonder de hele catalogus te doorzoeken.
Het gebruikt dezelfde catalogus als Biomarkers weergeven, dus stuur dezelfde herkomst mee. Een gearchiveerde biomarker geeft 404 terug. Dat geldt ook voor een biomarker die je voor die herkomst niet kunt bestellen bij de labs die je sleutel mag gebruiken.
Vereist de scope panels_access. Het pricing-object vereist ook de scope prices_view.
Padparameters
Queryparameters
De herkomst heeft één van twee vormen: een testlocatie of een thuistestkit. Stuur er precies één mee. Geen of beide geeft400 terug.
- Testlocatie
- Thuistestkit
Overschrijf welke tariefkaart
price_cents gebruikt: retail, of het id van een tariefkaart die je sleutel mag gebruiken. Tariefkaart ophalen geeft dat id terug. Standaard wordt de kaart van het factuuraccount van je API-sleutel gebruikt, anders retail.Respons
Standaard meeteenheid. Gebruik
id om te verwijzen naar Eenheden weergeven
als je een vaste identiteit nodig hebt bij naamswijzigingen.Wat deze biomarker kost en hoe deze wordt verkocht — zie
prijsobjecten.
null alleen als je sleutel de
scope prices_view mist; een biomarker waarvoor Aniva geen prijs heeft ingesteld wordt nog steeds
teruggegeven, met pricing.price_cents: null.Foutresponsen
| Status | Beschrijving |
|---|---|
400 | Validatiefout — ongeldig id, geen of twee herkomsten, of onbekende/niet-geautoriseerde rate_card. |
403 | Geen toegang — scope panels_access ontbreekt. |
404 | Biomarker niet gevonden, gearchiveerd of niet bestelbaar voor deze herkomst. Ook bij een onbekend location_id. |
500 | Interne serverfout. |
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]
}
]
}
}