Get task result metadata

Get task result metadata

Request

GET

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

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: en_US

Responses

200 OK

Task result metadata recieved.

Body

application/json
{
    "dates": [
        {
            "date": "string"
        }
    ],
    "dates_vehicles": [
        {
            "date": "string",
            "vehicle_id": "string"
        }
    ],
    "vehicles": [
        {
            "id": "string"
        }
    ]
}

Name

Description

dates*

Type: calendar_planning_metadata_dates_item[]

Dates with routes in the solution.

dates_vehicles*

Type: calendar_planning_metadata_dates_vehicles_item[]

Dates and vehicles correspondence.

vehicles*

Type: calendar_planning_metadata_vehicles_item[]

Vehicles with routes in the solution.

calendar_planning_metadata_dates_item

Name

Description

date

Type: string

Date.

calendar_planning_metadata_dates_vehicles_item

Name

Description

date

Type: string

Date.

vehicle_id

Type: string

Vehicle ID.

calendar_planning_metadata_vehicles_item

Name

Description

id

Type: string

Vehicle ID.

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.