Documente
Obține rezultatele documentului
Citește starea și valorile de laborator extrase ale unui document pe care l-ai încărcat
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
}
]
}
Citește statusul și valorile de laborator ale unui document pe care l-ai încărcat cu
Încarcă document. Răspunsul are aceeași structură ca
Obține rezultatele de laborator pentru o programare. Vezi
Rezultate pentru fiecare câmp.
Răspund doar documentele încărcate sub un grup de profiluri în care cheia ta poate citi rezultate. Orice alt
document returnează
404: citește rezultatele lui în cadrul programării sau comenzii de kit de testare la domiciliu care l-a produs.
Nu trebuie să faci polling. Abonează-te la webhook-urile document.results.updated sau document.results.completed
și apelează acest endpoint când sosește un eveniment.
Necesită scope-ul results_view pentru grupul de profiluri sub care a fost încărcat documentul.
Cerere
Parametri de cale
Antete
ETag-ul unui răspuns anterior. Când nu s-a schimbat nimic, API-ul răspunde cu 304 Not Modified,
fără corp.Răspuns
În caz de succes, API-ul returnează200 OK cu obiectul de rezultate și un antet ETag.
Una dintre:
in_progress— Aniva extrage valorile.completed— extragerea s-a încheiat.fault— extragerea a eșuat.stored— documentul nu are valori: l-ai încărcat fărăextract_resultssau nu conține rezultate de laborator.storedeste final: nu urmează niciun webhookdocument.results.completed.
Valorile extrase. Fiecare valoare are
origin: partner_upload. Un raport cu mai multe date de
recoltare oferă fiecărei valori propriul tested_at. Niciodată planned: o încărcare nu comandă nimic.Răspunsuri de eroare
| Status | Descriere |
|---|---|
304 | Nemodificat — etag-ul If-None-Match încă corespunde. Fără corp. |
400 | Format invalid pentru ID. |
403 | Cheia ta API nu are scope-ul results_view. |
404 | Niciun document încărcat sub unul dintre grupurile tale de profiluri nu are acest ID. |
500 | Eroare internă de server. |
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
}
]
}