Gets the sensors for the route by route ID and company ID

Gets the sensors for the route by route ID and company ID.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}/sensors

Path parameters

Name

Description

company_id*

Type: integer

The ID of the company.

route_id*

Type: integer

Route ID that is used in requests to the Track & Trace API.

Responses

200 OK

Success.

Body

application/json
[
    {
        "sensor_number": "string",
        "sensor_range_id": "string",
        "sensor_name": "string",
        "status": "pending",
        "created_at": {
            "value": 0,
            "text": "string"
        }
    }
]

RouteSensorsResponseList[]

RouteSensorsResponseList

Name

Description

sensor_name*

Type: string

Display name for the sensor on this route.

Min length: 1

Max length: 80

sensor_number*

Type: string

Number of the sensor configured on the gps-tracker device.

Min length: 1

Max length: 80

Pattern: ^[-_a-zA-Z0-9]+$

status*

Type: string

Sensor status.

Enum: pending, active, error

created_at

Type: RouteSensorResponse_created_at

sensor_range_id

Type: string

Id of the sensor-range.

RouteSensorResponse_created_at

Name

Description

text*

Type: string

The time of sensor to route binding, in ISO 8601 format. Example — '2018-09-06T10:15:00+00:00'.

value*

Type: number<integer>

UNIX timestamp of sensor to route binding.

401 Unauthorized

Deprecated

Authorization failed. Send the correct OAuth token in the authorization header.

403 Forbidden

Deprecated

You do not have access to this object.

422 Unprocessable Entity

Deprecated

Incorrect input.

504 Gateway Timeout

Deprecated

Server error during request processing.