Gets task result

Returns the result of MVRP task.

Request

GET

https://courier.yandex.ru/api/v1/vrs/result/mvrp/{task_id}

Path parameters

Name

Description

task_id*

Type: string

MVRP task id.

Query parameters

Name

Description

lang

Type: string

Response locale in RFC-3066 format.

Responses

200 OK

Task has completed.

Body

application/json

{
    "id": "string",
    "message": "string",
    "status": {
        "queued": 0,
        "started": 0,
        "completed": 0,
        "cancelled": 0,
        "estimate": 0
    }
}

Name	Description
id*	Type: string Task unique id.
status*	Type: task_info_status Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
message	Type: string Human-readable description of task state.

task_info_status

Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status.

Possible status transits: queued -> started -> (completed or cancelled)

Name	Description
queued*	Type: number Task has been queued for execution.
cancelled	Type: number Task execution has been cancelled by user or system due to timeout or error.
completed	Type: number Task execution completed with result or error.
estimate	Type: 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.
started	Type: number Task execution has been started.

201 Created

Task has started.

Body

application/json

{
    "id": "string",
    "message": "string",
    "status": {
        "queued": 0,
        "started": 0,
        "completed": 0,
        "cancelled": 0,
        "estimate": 0
    }
}

Name	Description
id*	Type: string Task unique id.
status*	Type: task_info_status Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
message	Type: string Human-readable description of task state.

202 Accepted

Task has been queued for execution.

Body

application/json

{
    "id": "string",
    "message": "string",
    "status": {
        "queued": 0,
        "started": 0,
        "completed": 0,
        "cancelled": 0,
        "estimate": 0
    }
}

Name	Description
id*	Type: string Task unique id.
status*	Type: task_info_status Task statuses object. Keys are task statuses, values are UNIX timestamps for corresponding status. Possible status transits: `queued` -> `started` -> (`completed` or `cancelled`)
message	Type: string Human-readable description of task state.

403 Forbidden

You do not have access to this task.

410 Gone

Requested task is not found.

Body

application/json

{
    "error": {
        "message": "string",
        "incident_id": "string"
    }
}

Name

Description

error*

Type: error_error

Error description.

error_error

Error description.

Name

Description

message*

Type: string

Human-readable error description.

incident_id

Type: string

Unique identifier of error incident. In case of API error, this identifier can be provided to support for investigation.

500 Internal Server Error

Server error during processing.

Body

application/json

{
    "error": {
        "message": "string",
        "incident_id": "string"
    }
}

Name

Description

error*

Type: error_error

Error description.

Body

text/html

{}

Gets task result

Request

Path parameters

Query parameters

Responses

200 OK

Body

task_info_status

201 Created

Body

202 Accepted

Body

403 Forbidden

410 Gone

Body

error_error

500 Internal Server Error

Body

Body

Was the article helpful?