Dokumentit
Poista dokumentti
Poista palveluun lataamasi dokumentti sekä siitä poimitut tulokset
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
}
Poista asiakirja, jonka lähetit Lähetä asiakirja -päätepisteellä. Käytä tätä, kun
lähetit tiedoston väärään profiiliin. Aniva poistaa tiedoston ja kaikki siitä poimitut arvot.
Arvot poistuvat myös jäsenen Aniva-sovelluksesta.
Vaatii
documents_upload-scopen profiiliryhmälle, johon asiakirja lähetettiin.
Aniva lähettää sen jälkeen document.deleted-webhookin päätepisteisiin, jotka saivat
asiakirjan viimeisimmän tulostapahtuman. Poistoa ei voi perua.
Pyyntö
Polkuparametrit
Vastaus
Onnistuessaan API palauttaa200 OK.
Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Virheellinen tunnuksen muoto. |
403 | API-avaimeltasi puuttuu documents_upload-scope. |
404 | Yhdessäkään profiiliryhmistäsi ei ole tällä tunnuksella lähetettyä asiakirjaa. |
500 | Sisäinen palvelinvirhe. |
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
}