REST API DropCat: получение контента документов (пакетом)
GET /stackDocuments
Метод возвращает контент документов согласно идентификаторам, указанным в запросе.
Формат запроса
Запрос списка всех файлов следует отправлять с помощью метода GET.
/stackDocuments
? [id_type= <тип идентификатора>]
& [org_id= <идентификатор организации>]
& [ids= <идентификаторы документов в системе>]
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln | Тип идентификатора организации. Принимает значения: gln или fns. | query | string |
| org_id* | 2000000009994 | Идентификатор организации-инициатора запроса. | query | string |
| ids* | 131710906,131711346,131711368 | Идентификаторы документов к получению. Передаются через запятую, без пробелов. Список на 100 значений. | query | string |
*Обязательный параметр.
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200.
Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
В ответе формируется пакет документов:
- Если документ не подписан, то для результата подготавливается xml-документ.
- Если документ подписан, то формируется архив. xml+подпись/подписи размещаются в корне архива.
-
Формируется опись документов. Опись - xml-файл с метаинформацией к списку полученных документов. Имя файла Inventory.xml. XSD-схема с описанием можете просмотреть по ссылке.
Curl
curl -X GET --header "Accept: application/json" "https://dapi-preprod.ediweb.ru/edi/api/v1.1/stackDocuments?id_type=gln&org_id=2000000009994&doc_ids=131710906%2C131711346%2C131711368"
URL запроса
https://dapi-preprod.ediweb.ru/edi/api/v1.1/stackDocuments?id_type=gln&org_id=2000000009994&doc_ids=131710906%2C131711346%2C131711368
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-disposition": "attachment; filename=StackDocuments_RESPONSE_20052021095139.zip",
"content-length": "2004",
"content-type": "text/plain; charset=UTF-8",
"date": "Thu, 20 May 2021 09:51:51 GMT",
"file_name": "U3RhY2tEb2N1bWVudHNfUkVTUE9OU0VfMjAwNTIwMjEwOTUxMzkuemlw",
"request_uuid": "a7d91883-48ec-4af5-abe3-e3886c1986e2",
"server": "nginx"
}