Получение документов

Получение документов

Получение контента документов по заказу.

Запрос

  • method — содержит информацию о типе запроса. Тип данных — строка.
  • apiVersion — содержит информацию о версии API. Тип данных — строка.
  • params — параметры объекта. Тип данных — сложный.
  • params.type — тип объекта. Тип данных — строка.
  • params.transactionId — идентификатор транзакции из Немо1. Тип данных — целое 32-битное число.
  • params.orderId — ID заказа из Немо1. Тип данных — целое 32-битное число.
  • params.documents — контейнер с данными о документах. Тип данных — сложный.
  • params.documents.name — имя документа. Тип данных — строка.
  • params.documents.type — тип документа. Тип данных — строка.
  • params.requestId — идентификатор заказа. Тип данных — строка.
  • params.sign — подпись запроса. Тип данных — строка.
Пример
{
    "method": "import",
    "apiVersion": "1.0",
    "params": {
            "type": "document",
            "transactionId": XXX,
            "orderId": XXX,
            "documents": [
                    {
                            "name": "XXX",
                            "type": null
                    }
            ],
            "requestId": "0e0d2dadd8d42961e57a1f90c4d0d495",
            "sign": "fccff0d3bb9a55ab8998a974f16a220db821e041391e00d6c48441c93617ce27"
    }
}

Ответ

  • method — содержит информацию о типе выгрузки/запроса. Тип данных — строка.
  • apiVersion — содержит информацию о версии API. Тип данных — строка.
  • params — параметры объекта. Тип данных — сложный.
  • params.type — тип объекта. Тип данных — строка.
  • params.transactionId — идентификатор транзакции из Немо1. Тип данных — целое 32-битное число.
  • params.orderId — ID заказа из Немо1. Тип данных — целое 32-битное число.
  • params.requestId — идентификатор заказа. Тип данных — строка.
  • data — контейнер с данными об объекте. Тип данных — сложный.
  • data.success — признак успешности. Тип данных — булевский.
  • data.documentsList — контейнер с данными о документах,Тип данных — сложный.
  • data.documentsList.name — имя сформированного документа. Тип данных — строка.
  • data.documentsList.type — тип сформированного документа. Тип данных — строка.
  • data.documentsList.content — base64 контента документа. Тип данных — строка.
Пример
{
    "method": "import",
    "apiVersion": "1.0",
    "params": {
            "type": "document",
            "transactionId": XXX,
            "orderId": XXX,
            "requestId": "0e0d2dadd8d42961e57a1f90c4d0d495"
    },
    "data": {
            "success": true,
            "documents": [
                    {
                            "name": "XXX",
                            "type": null,
                            "content": "base64(gzip(контент документа))"
                    }
            ]
    }
}