Delete

Отмечает указанный документ как удаленный.

POST /Delete
Query Parameters:

  • boxId – идентификатор ящика организации.

  • messageId – идентификатор сообщения.

  • documentId – идентификатор документа в сообщении. Необязательный параметр.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – не найдены документ или сообщение с указанным идентификатором.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 409 Conflict – документ или сообщение уже удалены.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Для выполнения метода текущий пользователь должен иметь доступ ко всем удаляемым документам, иначе метод вернет ошибку 403 (Forbidden).

Метод может удалять не только сообщения Message, но и шаблоны Template. Для этого в качестве параметра messageId нужно передать идентификатор сообщения шаблона.

Если параметр documentId не задан, то будет удалено сообщение messageId. В этом случае все документы в нем будут помечены как удаленные. Если из сообщения удален последний документ, то и само сообщение или шаблон будет помечено как удаленное.

Примеры использования

Пример HTTP-запроса:

POST /Delete?boxId={{boxid}}?messageid={{messageid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}

См. также

Инструкции:
Методы для работы с документами:

  • Delete — отмечает указанный документ как удаленный

  • GetContent — возвращает XSD-схему документа

  • GetDocument (V3) — возвращает данные документа по указанному идентификатору

  • GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам

  • GetDocumentsByMessageId — возвращает список документов из указанного сообщения

  • GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике

  • MoveDocuments — перемещает документы в указанное подразделение организации

  • Restore — восстанавливает документ из удаленных