Dokument
Radera dokument
Radera ett dokument som du har laddat upp, tillsammans med dess extraherade resultat
DELETE
/
api
/
v1
/
documents
/
{id}
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
Ta bort ett dokument som du laddat upp med Ladda upp dokument. Använd
detta när du laddat upp en fil till fel profil. Aniva tar bort filen och alla värden som extraherats
från den. Värdena försvinner också från medlemmens Aniva-app.
Kräver scopet
documents_upload för den profilgrupp som dokumentet laddades upp under.
Aniva skickar sedan webhooken document.deleted till de endpoints som tog emot
dokumentets senaste resultathändelse. En borttagning kan inte ångras.
Förfrågan
Sökvägsparametrar
Svar
Vid framgång returnerar API:et200 OK.
Felsvar
| Status | Beskrivning |
|---|---|
400 | Ogiltigt ID-format. |
403 | Din API-nyckel saknar scopet documents_upload. |
404 | Inget dokument som laddats upp under någon av dina profilgrupper har detta ID. |
500 | Internt serverfel. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}