REST API DropCat: удаление черновика документа
PUT /deleteDocument
Метод предназначен для удаление выбранного документа.
Общий запрос без дифференцирования по типам документов на платформе.
Возможно удалить документ только в статусе «Черновик».
Формат запроса
Запрос на удаление следует отправлять с помощью метода PUT.
/deleteDocument
? [id_type= <gln>]
& [org_id= <идентификатор>]
& [doc_id= <идентификатор>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln | Тип идентификатора организации. Принимает значения: gln или fns | query | string |
| org_id* | 2000000009994 | Идентификатор запроса организации-инициатора запроса | query | string |
| doc_id* |
51442005 |
Идентификатор документа в системе | query | long |
* Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
Curl
curl -X PUT --header "Content-Type: application/json" --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1/deleteDocument?id_type=gln&org_id=1089847223964&doc_id=51442005"
URL запроса
https://dapi-preprod.ediweb.ru/edi/api/v1/deleteDocument?id_type=gln&org_id=1089847223964&doc_id=51442005
Тело ответа
В теле ответа возвращается текстовое подтверждение удаления документа.
Document '51442005' was deleted
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-length": "31",
"content-type": "text/plain; charset=UTF-8",
"date": "Thu, 28 Mar 2019 12:53:24 GMT",
"request_uuid": "27370fc2-0376-49a7-8d2c-fc2353877c14",
"server": "nginx/1.11.10"
}