Получение статуса задачи на отправку извещений о получении¶
Запрос:
GET /receiveConfirmations/local/tasks/{taskId}
HTTP-заголовки:
Authorization: Bearer access_token
Accept: application/json
где {taskId}
- идентификатор поставленной задачи.
Описание запроса¶
Запрос позволяет получить статус задачи на отправку ИОП.
Ответ на запрос¶
В случае успешного выполнения запроса возвращается JSON, который содержит статус задачи:
{
"TaskStatus": 0, // статус обработки задачи
"TaskHandlingErrorMessage": "string", // сообщение об ошибке, если задача обработана с ошибкой
"Results": [ // результаты отправки ИОП для элементов очереди ИОП
]
}
Количество элементов в Results
равно количеству элементов очереди ИОП, переданных в запросе на отправку.
Результат отправки ИОП¶
Каждый результат отправки ИОП - это JSON вида:
{
"QueueItemId": 0, // идентификатор элемента очереди
"IsSent": true, // признак того, что ИОП были отправлены
"ErrorText": "string" // сообщение об ошибке, если ИОП не были отправлены
}
В поле QueueItemId
возвращается идентификатор элемента очереди, для которого отправлялись ИОП.
В поле
IsSent
возвращается признак того, что ИОП были отправлены.Если значение поля равно
true
, то отправка успешно завершена.Если значение поля равно
false
, то отправка завершена с ошибкой.В этом случае в поле
ErrorText
возвращается сообщение об ошибке, которая возникла при отправке.