Belgeler
Belge sonuçlarını getir
Yüklediğin bir belgenin durumunu ve çıkarılan laboratuvar değerlerini oku
GET
/
api
/
v1
/
documents
/
{id}
/
results
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
Belge yükle ile yüklediğin bir belgenin durumunu ve laboratuvar değerlerini
oku. Yanıt, bir randevu için Laboratuvar sonuçlarını al yanıtıyla aynı yapıdadır.
Her alan için Sonuçlar sayfasına bak.
Yalnızca anahtarının sonuçları okuyabildiği bir profil grubu altında yüklenen belgeler yanıt verir. Diğer tüm
belgeler
404 döndürür: sonuçlarını, belgeyi oluşturan randevu veya evde test kiti siparişi altından oku.
Sürekli sorgulama yapmana gerek yok. document.results.updated veya document.results.completed
webhook bildirimlerine abone ol ve bir olay geldiğinde bu uç noktayı çağır.
Belgenin yüklendiği profil grubunda results_view kapsamını gerektirir.
İstek
Yol parametreleri
Başlıklar
Önceki bir yanıtın
ETag değeri. Hiçbir şey değişmediyse API gövdesiz olarak 304 Not Modified
yanıtını verir.Yanıt
Başarılı olduğunda API, sonuçlar nesnesi ve birETag başlığıyla birlikte 200 OK döndürür.
Şunlardan biri:
in_progress— Aniva değerleri çıkarıyor.completed— çıkarma işlemi tamamlandı.fault— çıkarma işlemi başarısız oldu.stored— belgede değer yok: belgeyiextract_resultsolmadan yükledin veya belge laboratuvar sonuçları içermiyor.storedson durumdur: ardındandocument.results.completedwebhook bildirimi gelmez.
Çıkarılan değerler. Her değer
origin: partner_upload taşır. Birden fazla numune tarihine sahip
bir rapor her değere kendi tested_at tarihini verir. Asla planned olmaz: yükleme herhangi bir sipariş oluşturmaz.Hata yanıtları
| Durum | Açıklama |
|---|---|
304 | Değiştirilmedi — If-None-Match etag değeri hâlâ eşleşiyor. Gövde yok. |
400 | Geçersiz kimlik biçimi. |
403 | API anahtarında results_view kapsamı eksik. |
404 | Profil gruplarından birinin altında yüklü bu kimliğe sahip belge yok. |
500 | Dahili sunucu hatası. |
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}