Gets task result

Returns the result of MVRP task.

HTTP Request

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

Path Parameters

task_id *

string

MVRP task id.

* Required parameter

Query Parameters

lang

string

Response locale in RFC-3066 format.

* Required parameter

Responses

Code 200

Task has completed.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

id *	string Task unique id.
message	string Human-readable description of task state.
status *	object Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
status.cancelled	number Task execution has been cancelled by user or system due to timeout or error.
status.completed	number Task execution completed with result or error.
status.estimate	number Estimated time when task expected to be completed. The time estimation may change during solving process. The estimate is valid for approximately 75% of tasks (they may be ready 5-15 seconds before "estimate")Some tasks may require more time for calculation, typically this extra time is not more than 1 minute.
status.queued *	number Task has been queued for execution.
status.started	number Task execution has been started.

* Required parameter

Code 201

Task has started.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

id *	string Task unique id.
message	string Human-readable description of task state.
status *	object Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
status.cancelled	number Task execution has been cancelled by user or system due to timeout or error.
status.completed	number Task execution completed with result or error.
status.estimate	number Estimated time when task expected to be completed. The time estimation may change during solving process. The estimate is valid for approximately 75% of tasks (they may be ready 5-15 seconds before "estimate")Some tasks may require more time for calculation, typically this extra time is not more than 1 minute.
status.queued *	number Task has been queued for execution.
status.started	number Task execution has been started.

* Required parameter

Code 202

Task has been queued for execution.

{
  "id": string,
  "message": string,
  "status": {
    "cancelled": number,
    "completed": number,
    "estimate": number,
    "queued": number,
    "started": number
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

id *	string Task unique id.
message	string Human-readable description of task state.
status *	object Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
status.cancelled	number Task execution has been cancelled by user or system due to timeout or error.
status.completed	number Task execution completed with result or error.
status.estimate	number Estimated time when task expected to be completed. The time estimation may change during solving process. The estimate is valid for approximately 75% of tasks (they may be ready 5-15 seconds before "estimate")Some tasks may require more time for calculation, typically this extra time is not more than 1 minute.
status.queued *	number Task has been queued for execution.
status.started	number Task execution has been started.

* Required parameter

Code 403

You do not have access to this task.

Code 410

Requested task is not found.

{
  "error": {
    "incident_id": string,
    "message": string
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

error *	object Error description.
error.incident_id	string Unique identifier of error incident. In case of API error, this identifier can be provided to support for investigation.
error.message *	string Human-readable error description.

* Required parameter

Code 500

Server error during processing.

{
  "error": {
    "incident_id": string,
    "message": string
  }
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

error *	object Error description.
error.incident_id	string Unique identifier of error incident. In case of API error, this identifier can be provided to support for investigation.
error.message *	string Human-readable error description.

* Required parameter