Получает результат задачи

Ресурсы API

Возвращает результат выполнения MVRP-задачи.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/vrs/result/mvrp/{task_id}\
?lang={string}

Path-параметры

task_id *

string

Идентификатор MVRP-задачи.

* Обязательный параметр

Query-параметры

lang

string

Локаль ответа в формате RFC-3066.

* Обязательный параметр

Ответы

Код 200

Задача выполнена.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

id *	string Уникальный id задачи.
message	string Описание состояния задачи.
status *	object Объект, содержащий изменения статусов задачи. Ключи - статусы, значения - время в формате UNIX timestamp. Возможные изменения статусов: `queued` -> `started` -> (`completed` или `cancelled`)
status.cancelled	number Выполнение задачи отменено пользователем или системой в связи с ошибкой или истечением времени ожидания.
status.completed	number Выполнение задачи закончено успешно или с ошибкой.
status.estimate	number Оценочное время решения задачи. Оценка может меняться в процессе решения. Оценка верна примерно в 75% случаев (задачи решаются за 5-15 секунд до estimate). Для некоторых задач фактическое время решения может быть больше, чем указано в estimate (обычно, не более чем на 1 минуту).
status.queued *	number Задача поставлена в очередь на выполнение.
status.started	number Началось выполнение задачи.

* Обязательный параметр

Код 201

Началось выполнение задачи.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

id *	string Уникальный id задачи.
message	string Описание состояния задачи.
status *	object Объект, содержащий изменения статусов задачи. Ключи - статусы, значения - время в формате UNIX timestamp. Возможные изменения статусов: `queued` -> `started` -> (`completed` или `cancelled`)
status.cancelled	number Выполнение задачи отменено пользователем или системой в связи с ошибкой или истечением времени ожидания.
status.completed	number Выполнение задачи закончено успешно или с ошибкой.
status.estimate	number Оценочное время решения задачи. Оценка может меняться в процессе решения. Оценка верна примерно в 75% случаев (задачи решаются за 5-15 секунд до estimate). Для некоторых задач фактическое время решения может быть больше, чем указано в estimate (обычно, не более чем на 1 минуту).
status.queued *	number Задача поставлена в очередь на выполнение.
status.started	number Началось выполнение задачи.

* Обязательный параметр

Код 202

Задача поставлена в очередь на выполнение.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

id *	string Уникальный id задачи.
message	string Описание состояния задачи.
status *	object Объект, содержащий изменения статусов задачи. Ключи - статусы, значения - время в формате UNIX timestamp. Возможные изменения статусов: `queued` -> `started` -> (`completed` или `cancelled`)
status.cancelled	number Выполнение задачи отменено пользователем или системой в связи с ошибкой или истечением времени ожидания.
status.completed	number Выполнение задачи закончено успешно или с ошибкой.
status.estimate	number Оценочное время решения задачи. Оценка может меняться в процессе решения. Оценка верна примерно в 75% случаев (задачи решаются за 5-15 секунд до estimate). Для некоторых задач фактическое время решения может быть больше, чем указано в estimate (обычно, не более чем на 1 минуту).
status.queued *	number Задача поставлена в очередь на выполнение.
status.started	number Началось выполнение задачи.

* Обязательный параметр

Код 403

У вас нет доступа к этой задаче.

Код 410

Запрошенная задача не найдена.

{
  "error": {
    "incident_id": string,
    "message": string
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

error *	object Описание ошибки.
error.incident_id	string Уникальный идентификатор инцидента c ошибкой. При ошибке API этот идентификатор может использоваться при анализе проблем.
error.message *	string Сообщение с описанием ошибки.

* Обязательный параметр

Код 500

Ошибка сервера при обработке задачи.

{
  "error": {
    "incident_id": string,
    "message": string
  }
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

error *	object Описание ошибки.
error.incident_id	string Уникальный идентификатор инцидента c ошибкой. При ошибке API этот идентификатор может использоваться при анализе проблем.
error.message *	string Сообщение с описанием ошибки.

* Обязательный параметр

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

Добавляет задачу

Получает список арендованных транспортных средств для задачи

Добавляет задачу

Получает список арендованных транспортных средств для задачи