Dokumenter
Slet dokument
Slet et dokument, du har uploadet, sammen med dets udtrukne resultater
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
}
Slet et dokument, du har uploadet med Upload dokument. Brug det, når
du har uploadet en fil til den forkerte profil. Aniva sletter filen og alle værdier, der er udtrukket fra den.
Værdierne forsvinder også fra medlemmets Aniva-app.
Kræver scopet
documents_upload på den profilgruppe, som dokumentet blev uploadet under.
Aniva sender derefter webhooken document.deleted til de endpoints, der modtog
dokumentets seneste resultathændelse. En sletning kan ikke fortrydes.
Forespørgsel
Stiparametre
Svar
Ved succes returnerer API’et200 OK.
Fejlsvar
| Status | Beskrivelse |
|---|---|
400 | Ugyldigt id-format. |
403 | Din API-nøgle mangler scopet documents_upload. |
404 | Intet dokument uploadet under en af dine profilgrupper har dette id. |
500 | Intern serverfejl. |
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
}