Belgeler
Belgeyi sil
Yüklediğin bir belgeyi, çıkarılan sonuçlarıyla birlikte sil
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
}
Belge yükle ile yüklediğin bir belgeyi sil. Bir dosyayı yanlış profile
yüklediğinde kullan. Aniva dosyayı ve ondan çıkarılan tüm değerleri siler.
Değerler üyenin Aniva uygulamasından da kaldırılır.
Belgenin yüklendiği profil grubunda
documents_upload kapsamını gerektirir.
Aniva ardından belgenin son sonuçlar olayını alan uç noktalara document.deleted webhook bildirimini
gönderir. Silme işlemi geri alınamaz.
İstek
Yol parametreleri
Yanıt
Başarılı olduğunda API200 OK döndürür.
Hata yanıtları
| Durum | Açıklama |
|---|---|
400 | Geçersiz kimlik biçimi. |
403 | API anahtarında documents_upload kapsamı eksik. |
404 | Profil gruplarından birinin altında yüklü bu kimliğe sahip belge yok. |
500 | Dahili sunucu hatası. |
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
}