Документы
Удалить документ
Удалить загруженный тобой документ вместе с извлечёнными результатами
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
}