Dokumenti
Dzēst dokumentu
Dzēst tavu augšupielādēto dokumentu kopā ar no tā izgūtajiem rezultātiem
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
}
Dzēs dokumentu, ko augšupielādēji ar Augšupielādēt dokumentu. Izmanto to, ja
augšupielādēji failu nepareizajā profilā. Aniva izdzēš failu un visas no tā izgūtās vērtības.
Vērtības pazūd arī no dalībnieka Aniva lietotnes.
Nepieciešama
documents_upload darbības joma profila grupai, kurā dokuments tika augšupielādēts.
Pēc tam Aniva nosūta document.deleted webhook paziņojumu galapunktiem, kas saņēma
dokumenta pēdējo rezultātu notikumu. Dzēšanu nevar atsaukt.
Pieprasījums
Ceļa parametri
Atbilde
Veiksmes gadījumā API atgriež200 OK.
Kļūdu atbildes
| Statuss | Apraksts |
|---|---|
400 | Nederīgs ID formāts. |
403 | Tavai API atslēgai trūkst documents_upload 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 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
}