Get task status
Get calendar planning task status.
Request
GET
https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks/{id}/status
Path parameters
|
Name |
Description |
|
id* |
Type: string<byte> Task ID to query status or result. |
Query parameters
|
Name |
Description |
|
apikey* |
Type: string API key. |
|
lang |
Type: string Response locale in RFC-3066 format. Default: |
Responses
200 OK
Task status recieved.
Body
application/json
{
"estimate": 0,
"id": "string",
"message": "string",
"status": "string"
}
|
Name |
Description |
|
id* |
Type: string Task unique id. |
|
message* |
Type: string Human-readable description of task state. |
|
status* |
Type: string Task status. |
|
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. |
400 Bad Request
Invalid query parameters or body.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
error_1_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. |
401 Unauthorized
Missing or invalid apikey.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
402 Payment Required
Banned apikey.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
404 Not Found
Task not found.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
500 Internal Server Error
Server error during request processing.
Body
application/json
{
"error": {
"incident_id": "string",
"message": "string"
}
}
|
Name |
Description |
|
error* |
Type: error_1_error Error description. |
No longer supported, please use an alternative and newer version.