Dokumenti
Iegūt dokumenta rezultātus
Lasīt tava augšupielādētā dokumenta statusu un izgūtās laboratorijas vērtības
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
}
]
}
Nolasi statusu un laboratorijas vērtības dokumentam, ko augšupielādēji ar
Augšupielādēt dokumentu. Atbildei ir tāda pati struktūra kā
Iegūt laboratorijas rezultātus pierakstam. Visus laukus skati sadaļā
Rezultāti.
Ir pieejami tikai tie dokumenti, kas augšupielādēti profila grupā, kurā tava atslēga lasa rezultātus. Jebkurš cits
dokuments atgriež
404: nolasi tā rezultātus pie pieraksta vai mājas testa komplekta pasūtījuma, kas to radīja.
Tev nav regulāri jāveic pieprasījumi. Abonē document.results.updated vai document.results.completed
webhook paziņojumus un izsauc šo galapunktu, kad pienāk notikums.
Nepieciešama results_view darbības joma profila grupai, kurā dokuments tika augšupielādēts.
Pieprasījums
Ceļa parametri
Galvenes
Iepriekšējās atbildes
ETag. Ja nekas nav mainījies, API atbild ar 304 Not Modified
bez satura.Atbilde
Ja pieprasījums ir veiksmīgs, API atgriež200 OK ar rezultātu objektu un galveni ETag.
Viens no:
in_progress— Aniva izgūst vērtības.completed— izgūšana pabeigta.fault— izgūšana neizdevās.stored— dokumentā nav vērtību: tu to augšupielādēji bezextract_resultsvai tajā nav laboratorijas rezultātu.storedir galīgais statuss: tam nesekodocument.results.completedwebhook paziņojums.
Izgūtās vērtības. Katrai vērtībai ir
origin: partner_upload. Pārskats ar vairākiem paraugu
datumiem katrai vērtībai piešķir savu tested_at. Nekad nav planned: augšupielāde neko nepasūta.Kļūdu atbildes
| Statuss | Apraksts |
|---|---|
304 | Nav mainīts — If-None-Match etag joprojām atbilst. Bez satura. |
400 | Nederīgs ID formāts. |
403 | Tavai API atslēgai trūkst results_view darbības jomas. |
404 | Nevienā no tavām profila grupām nav augšupielādēta dokumenta ar šādu ID. |
500 | Iekšēja servera kļūda. |
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
}
]
}