REST API DropCat: прочтение документов
PUT /readDocuments
Метод позволяет отметить документ прочитанным.
Общий запрос без дифференцирования по типам документов на платформе.
Формат запроса
Запрос на прочтение документа следует отправлять с помощью метода PUT.
/edi/api/v1.1/readDocuments ? [id_type= <тип идентификатора>] & [org_id= <идентификатор>] & [doc_ids= <идентификатор>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln |
Тип идентификатора организации. Принимает значения: gln или fns. |
query | string |
| org_id* | 2000000007705 | Идентификатор организации-инициатора запроса (gln). | query | string |
| doc_ids* | 103940815 |
Идентификаторы документов в системе CorePlat. При необходимости отметить список документов прочитанным, идентификаторы документов передаются через запятую. |
query | string |
*Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
Curl
curl -X PUT --header "Content-Type: application/json" --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1.1/readDocuments?id_type=gln&org_id=3828827222272&doc_ids=460542617"
URL запроса
https://dapi-preprod.ediweb.ru/edi/api/v1.1/readDocuments?id_type=gln&org_id=3828827722272&doc_ids=460542617
Тело ответа
В теле ответа возвращается текстовое подтверждение прочтения документа.
{"processedDocuments":[460542617],"exceptions":[]}
HTTP код ответа
200
Заголовки ответа
{ "connection": "keep-alive", "content-length": "36", "content-type": "text/plain; charset=UTF-8", "date": "Fri, 03 Apr 2020 15:24:56 GMT", "doc_id": "460542617", "request_uuid": "be63afe4-30e6-4365-9766-2c21c9e841f5", "server": "nginx" }