Документи
Видалити документ
Видалити завантажений тобою документ разом із витягнутими з нього результатами
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
}
Видали документ, завантажений через Завантажити документ. Використовуй цей запит,
якщо файл завантажено не до того профілю. Aniva видаляє файл і всі витягнуті з нього значення.
Значення також зникають із застосунку Aniva учасника.
Потрібен дозвіл
documents_upload для групи профілів, у яку завантажено документ.
Потім Aniva надсилає вебхук document.deleted на ендпоінти, які отримали
останню подію результатів цього документа. Видалення неможливо скасувати.
Запит
Параметри шляху
Відповідь
У разі успіху API повертає200 OK.
Відповіді з помилками
| Статус | Опис |
|---|---|
400 | Неправильний формат ID. |
403 | Твоєму API-ключу бракує дозволу documents_upload. |
404 | Жоден документ, завантажений у твої групи профілів, не має такого ID. |
500 | Внутрішня помилка сервера. |
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
}