Testivalikoima
Hae biomarkkeri
Hae yksittäinen biomarkkeri ID:llä
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]
}
]
}
}
Palauttaa yksittäisen biomarkkerin sen numeerisen
id-tunnisteen perusteella. Kätevä, kun haluat muuntaa Listaa paneelit -kutsun tai ajanvaraustietojen palauttamat tunnisteet täysiksi tiedoiksi (nimi, yksikkö, materiaali, kategoria) käymättä läpi koko luetteloa.
Se käyttää samaa luetteloa kuin Listaa biomarkkerit, joten lähetä sama alkuperä. Arkistoitu biomarkkeri palauttaa koodin 404. Samoin käy biomarkkerille, jota et voi tilata kyseiselle alkuperälle avaimesi käytettävissä olevilla laboratorioilla.
Vaatii panels_access-käyttöoikeuden. pricing-objekti vaatii lisäksi prices_view-käyttöoikeuden.
Polkuparametrit
Kyselyparametrit
Alkuperällä on kaksi mahdollista muotoa: testauspiste tai kotitestipakkaus. Lähetä tarkalleen yksi. Jos et lähetä kumpaakaan tai lähetät molemmat, pyyntö palauttaa koodin400.
- Testauspiste
- Kotitestipakkaus
Ohita
price_cents-kentän käyttämä hinnasto: retail tai sellaisen hinnaston id, jota avaimesi saa käyttää. Hae hinnasto palauttaa kyseisen id-tunnisteen. Oletuksena käytetään API-avaimesi laskutustilin hinnastoa, muussa tapauksessa vähittäishinnastoa.Vastaus
Oletusmittayksikkö. Käytä
id-tunnistetta viitataksesi Listaa yksiköt
-luetteloon, jos tarvitset pysyvän tunnisteen nimimuutoksista huolimatta.Mitä tämä biomarkkeri maksaa ja miten sitä myydään – katso
hintaobjektit.
null vain, kun avaimeltasi
puuttuu prices_view-käyttöoikeus; biomarkkeri, jota Aniva ei ole hinnoitellut, palautetaan
silti arvolla pricing.price_cents: null.Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Validointivirhe – virheellinen id, alkuperä puuttuu tai alkuperiä on kaksi, tai tuntematon/luvaton rate_card. |
403 | Estetty – panels_access-käyttöoikeus puuttuu. |
404 | Biomarkkeria ei löytynyt, se on arkistoitu tai sitä ei voi tilata kyseiselle alkuperälle. Myös tuntematon location_id. |
500 | Sisäinen palvelinvirhe. |
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]
}
]
}
}