Получить статус задачи

Получить статус задачи календарного планирования.

Request

GET

https://courier.yandex.ru/vrs/api/v1/calendar_planning/tasks/{id}/status

Path parameters

Name

Description

id*

Type: string<byte>

Идентификатор задачи, используемый для запроса ее состояния или результата.

Query parameters

Name

Description

apikey*

Type: string

Ключ доступа к API.

lang

Type: string

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

Default: en_US

Responses

200 OK

Получен статус задачи.

Body

application/json
{
    "estimate": 0,
    "id": "string",
    "message": "string",
    "status": "string"
}

Name

Description

id*

Type: string

Уникальный id задачи.

message*

Type: string

Описание состояния задачи.

status*

Type: string

Статус задачи.

estimate

Type: number

Оценочное время решения задачи. Оценка может меняться в процессе решения. Оценка верна примерно в 75% случаев (задачи решаются за 5-15 секунд до estimate). Для некоторых задач фактическое время решения может быть больше, чем указано в estimate (обычно, не более чем на 1 минуту).

400 Bad Request

Недопустимые параметры или тело запроса.

Body

application/json
{
    "error": {
        "incident_id": "string",
        "message": "string"
    }
}

Name

Description

error*

Type: error_1_error

Описание ошибки.

error_1_error

Описание ошибки.

Name

Description

message*

Type: string

Сообщение с описанием ошибки.

incident_id

Type: string

Уникальный идентификатор инцидента c ошибкой. При ошибке API этот идентификатор может использоваться при анализе проблем.

401 Unauthorized

API-ключ отсутствует или не валиден.

Body

application/json
{
    "error": {
        "incident_id": "string",
        "message": "string"
    }
}

Name

Description

error*

Type: error_1_error

Описание ошибки.

402 Payment Required

API-ключ отключен.

Body

application/json
{
    "error": {
        "incident_id": "string",
        "message": "string"
    }
}

Name

Description

error*

Type: error_1_error

Описание ошибки.

404 Not Found

Задача не найдена.

Body

application/json
{
    "error": {
        "incident_id": "string",
        "message": "string"
    }
}

Name

Description

error*

Type: error_1_error

Описание ошибки.

500 Internal Server Error

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

Body

application/json
{
    "error": {
        "incident_id": "string",
        "message": "string"
    }
}

Name

Description

error*

Type: error_1_error

Описание ошибки.

No longer supported, please use an alternative and newer version.