Dokumentumok
Dokumentum eredményeinek lekérése
Egy általad feltöltött dokumentum állapotának és kinyert laborértékeinek kiolvasása
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
}
]
}
Olvasd le a Dokumentum feltöltése segítségével feltöltött
dokumentum állapotát és laborértékeit. A válasz szerkezete megegyezik egy időpont
Laboreredmények lekérése válaszával. Az összes mezőt az
Eredmények oldalon találod.
Csak azok a dokumentumok adnak választ, amelyeket olyan profilcsoport alá töltöttek fel, amelyben
a kulcsod olvashatja az eredményeket. Minden más dokumentum
404 választ ad: olvasd le az
eredményeit annál az időpontnál vagy otthoni tesztkészlet-rendelésnél, amely létrehozta.
Nem kell folyamatosan lekérdezned. Iratkozz fel a document.results.updated vagy a document.results.completed
webhookokra, és akkor hívd meg ezt a végpontot, amikor esemény érkezik.
A results_view scope szükséges hozzá annál a profilcsoportnál, amely alá a dokumentumot feltöltötték.
Kérés
Útvonalparaméterek
Fejlécek
Egy korábbi válasz
ETag értéke. Ha semmi nem változott, az API 304 Not Modified választ ad
törzs nélkül.Válasz
Sikeres kérés esetén az API200 OK választ ad vissza az eredmények objektumával és egy ETag fejléccel.
Az alábbiak egyike:
in_progress– az Aniva éppen kinyeri az értékeket.completed– a kinyerés befejeződött.fault– a kinyerés sikertelen volt.stored– a dokumentum nem tartalmaz értékeket:extract_resultsnélkül töltötted fel, vagy nem tartalmaz laboreredményeket. Astoredvégleges állapot: nem követidocument.results.completedwebhook.
A kinyert értékek. Minden érték tartalmazza az
origin: partner_upload mezőt. A több mintavételi
dátumot tartalmazó lelet minden értékhez saját tested_at értéket rendel. Soha nem planned: egy
feltöltés nem rendel semmit.Hibaválaszok
| Státusz | Leírás |
|---|---|
304 | Nem módosult – az If-None-Match etag értéke továbbra is megegyezik. Nincs törzs. |
400 | Érvénytelen azonosítóformátum. |
403 | Az API-kulcsodból hiányzik a results_view scope. |
404 | Egyetlen profilcsoportod alá feltöltött dokumentumnak sincs ilyen azonosítója. |
500 | Belső szerverhiba. |
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
}
]
}