REST API DropCat: получение архивов документов
GET /getStackDocumentArchives
Метод позволяет получить архив со всеми имеющимися на данный момент титулами и подписями. Для титулов без подписи возвращается xml-файл.
Формат запроса
Параметры запроса
| Параметр | Пример значения | Описание | Тип параметра | Тип данных |
|---|---|---|---|---|
| id_type* | gln |
Тип идентификатора организации. Принимает значения: gln или fns. |
query | string |
| org_id* | 2000000009994 | Идентификатор запроса организации-инициатора запроса. | query | string |
| doc_ids* |
116308645 |
Идентификатор документа в системе. | query | long |
*Обязательный параметр
Формат ответа
Если запрос был обработан без ошибок, API отвечает кодом 200. Если запрос вызвал ошибку, возвращается подходящий код ответа, а тело ответа содержит описание ошибки.
В заголовке ответа возвращается request_uuid - идентификатор корреляции запроса.
В теле ответа возвращается zip-архив с информацией по идентификаторам.
URL запроса
http://dapi-preprod.ediweb.ru/edi/api/v1.1/getStackDocumentArchives?id_type=gln&org_id=2359874562330&doc_ids=21966959%2C21962431
Тело ответа
В теле ответа возвращается zip-архив с информацией. Состав архива:
- xml-файл описи – файл описи формируется с именем Inventory.xml внутри по каждому запрошенному документу
- zip-архив в корне которого расположены все архивы с документами
HTTP код ответа
200
Заголовки ответа
{
"connection": "keep-alive",
"content-disposition": "attachment; filename=StackQrCodes_RESPONSE_31082023102612.zip",
"content-encoding": "gzip",
"content-length": "65222",
"content-type": "text/plain; charset=UTF-8",
"date": "Thu, 31 Aug 2023 10:26:13 GMT",
"file_name": "U3RhY2tRckNvZGVzX1JFU1BPTlNFXzMxMDgyMDIzMTAyNjEyLnppcA==",
"request_uuid": "0f3b8954-0d9a-443a-8793-8530ee782918",
"server": "nginx/1.22.0"
}