Testkatalog
Hent biomarkør
Hent en enkelt biomarkør 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]
}
]
}
}
Returnerer en enkelt biomarkør basert på dens numeriske
id. Nyttig for å slå opp ID-ene som returneres av Vis paneler eller payloads for timer for å få fullstendige detaljer (navn, enhet, materiale, kategori) uten å skanne hele katalogen.
Den bruker samme katalog som Vis biomarkører, så send samme opprinnelse. En arkivert biomarkør returnerer 404. Det gjør også en biomarkør du ikke kan bestille for den opprinnelsen med laboratoriene nøkkelen din kan bruke.
Krever scopet panels_access. Objektet pricing krever også scopet prices_view.
Stiparametere
Spørreparametere
Opprinnelsen har én av to former: et teststed eller et hjemmetestsett. Send nøyaktig én. Ingen eller begge returnerer400.
- Teststed
- Hjemmetestsett
Overstyr hvilken prisliste
price_cents bruker: retail, eller id for en prisliste nøkkelen din kan bruke. Hent prisliste returnerer denne id-en. Standard er prislisten på faktureringskontoen til API-nøkkelen din, ellers veiledende prisliste.Respons
Standard måleenhet. Bruk
id for å slå opp mot Vis enheter hvis du
trenger stabil identitet på tvers av navneendringer.Hva denne biomarkøren koster og hvordan den selges – se
prisobjekter.
null kun når nøkkelen din
mangler scopet prices_view; en biomarkør Aniva ikke har priset returneres likevel, med
pricing.price_cents: null.Feilresponser
| Status | Beskrivelse |
|---|---|
400 | Valideringsfeil – ugyldig id, ingen eller to opprinnelser, eller ukjent/uautorisert rate_card. |
403 | Forbudt – mangler scopet panels_access. |
404 | Biomarkøren ble ikke funnet, er arkivert eller kan ikke bestilles for opprinnelsen. Også ved ukjent location_id. |
500 | Intern serverfeil. |
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]
}
]
}
}