Загрузка результатов генерации¶

Запрос: GET /receiveConfirmations/content/tasks/{taskId}

HTTP-заголовки:

Authorization: Bearer access_token
Accept: application/json

где {taskId} - идентификатор поставленной задачи на генерацию ИОП.

Описание запроса¶

Запрос позволяет получить статус и результаты задачи на генерацию ИОП.

Ответ на запрос¶

В случае успешного выполнения запроса возвращается JSON, который содержит статус задачи и результаты генерации:

{
    "TaskStatus": 0,                            // статус обработки задачи
    "TaskHandlingErrorMessage": "string"        // сообщение об ошибке, если задача обработана с ошибкой
    "Results": [                                // результаты генерации ИОП
    ]
}

Количество элементов в Results не превышает количество элементов очереди ИОП, переданных в запросе на генерацию, однако может быть меньше него, если по какой-то причине не удалось сгенерировать ИОП для части элементов (например, из-за временных проблем с подключением к сервису оператора).

Задача на генерацию считается успешно обработанной, если в Results есть хотя бы один результат. Поле TaskStatus при этом равно 1.

Результат генерации ИОП¶

Каждый результат генерации ИОП - это JSON вида:

{
    "QueueItemId": 0,                   // идентификатор элемента очереди ИОП
    "ExtraQueueItemData": "string",     // дополнительные данные для элемента очереди
    "Receipts": [                       // ИОП, сгенерированные для элемента очереди
        {
            "DocumentId": "guid",       // идентификатор документа, для которого сгенерировано ИОП
            "Name": "string",           // имя файла ИОП
            "ContentLinkId": "string"   // ссылка на контент ИОП в архиве
        }
    ]
}

В поле QueueItemId возвращается идентификатор элемента очереди, для которого сгенерированы ИОП.

В поле ExtraQueueItemData могут возвращаться данные, специфичные для процесса отправки ИОП через заданного оператора ЭДО. Внешняя система не должна анализировать эти данные или полагаться на их структуру. Если эти данные возвращены, то внешняя система должна их сохранить и передать вместе с подписанными ИОП в запросе на отправку.

В поле Receipts возвращаются сгенерированные ИОП. Для одного элемента очереди их может быть несколько.

Поле DocumentId определяет документ, для которого сгенерировано ИОП. Само ИОП сохранено в архив и доступно по ссылке ContentLinkId. По этой ссылке вложение нужно загрузить с помощью Archive API для подписания.