Gets company's sensor-range by ID

Gets company's sensor-range by ID.

Request

GET

https://courier.yandex.ru/api/v1/companies/{company_id}/sensor-ranges/{sensor_range_id}

Path parameters

Name

Description

company_id*

Type: integer

The ID of the company.

sensor_range_id*

Type: string

The ID of the sensor-range.

Responses

200 OK

Success.

Body

application/json
{
    "id": "string",
    "number": "string",
    "min": 0,
    "max": 0,
    "threshold_time": 0,
    "comment": "string"
}

Name

Description

max*

Type: number<float>

Maximum allowed value.

Min value: -32768

Max value: 32767

min*

Type: number<float>

Minimum allowed value.

Min value: -32768

Max value: 32767

number*

Type: string

Sensor range number. Used for syncing with the delivery company's system.

Min length: 1

Max length: 80

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

comment

Type: string

Description of the sensor-range.

Max length: 1023

id

Type: string

ID of the sensor-range.

threshold_time

Type: integer

Threshold time during which the sensor can exceed the threshold value (in seconds, default is taken from the company settings).

Max value: 604800

401 Unauthorized

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

403 Forbidden

You do not have access to this object.

422 Unprocessable Entity

Incorrect input.

504 Gateway Timeout

Server error during request processing.