Test kataloğu
Biyobelirteci getir
ID ile tek bir biyobelirteci getir
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]
}
]
}
}
Sayısal
id değerine göre tek bir biyobelirteç döndürür. Panelleri listele veya randevu verilerinden dönen ID’leri tüm kataloğu taramadan eksiksiz ayrıntılara (ad, birim, materyal, kategori) çözümlemek için kullanışlıdır.
Biyobelirteçleri listele ile aynı kataloğu sunar, bu nedenle aynı kaynağı gönder. Arşivlenmiş bir biyobelirteç 404 döndürür. Anahtarının kullanabileceği laboratuvarlarla o kaynakta sipariş edemeyeceğin bir biyobelirteç için de aynı durum geçerlidir.
panels_access kapsamını gerektirir. pricing nesnesi ayrıca prices_view kapsamını gerektirir.
Yol parametreleri
Sorgu parametreleri
Kaynak iki biçimden biridir: test konumu veya evde test kiti. Tam olarak birini gönder. Hiçbirini veya ikisini birden göndermek400 döndürür.
- Test konumu
- Evde test kiti
price_cents alanının hangi fiyat tarifesini kullanacağını geçersiz kıl: retail veya anahtarının kullanabileceği bir fiyat tarifesinin id değeri. Fiyat tarifesini getir bu id değerini döndürür. Varsayılan olarak API anahtarının faturalandırma hesabındaki tarifeyi, yoksa perakende tarifesini kullanır.Yanıt
Varsayılan ölçüm birimi. Yeniden adlandırmalarda sabit kimliğe ihtiyacın varsa
id değerini
Birimleri listele ile eşleştirmek için kullan.Bu biyobelirtecin fiyatı ve nasıl satıldığı — bkz. fiyat
nesneleri. Yalnızca anahtarında
prices_view kapsamı eksik olduğunda null olur; Aniva’nın fiyatlandırmadığı bir biyobelirteç
yine de pricing.price_cents: null ile döndürülür.Hata yanıtları
| Durum | Açıklama |
|---|---|
400 | Doğrulama hatası — geçersiz id, kaynak belirtilmemiş veya iki kaynak verilmiş ya da bilinmeyen/yetkisiz rate_card. |
403 | Yasak — panels_access kapsamı eksik. |
404 | Biyobelirteç bulunamadı, arşivlendi veya bu kaynakta sipariş edilemiyor. Bilinmeyen bir location_id için de döner. |
500 | Dahili sunucu hatası. |
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]
}
]
}
}