Gets company's sensor-ranges
Gets company's sensor-ranges.
Request
GET
https://courier.yandex.ru/api/v1/companies/{company_id}/sensor-ranges
Path parameters
|
Name |
Description |
|
company_id* |
Type: integer The ID of the company. |
Query parameters
|
Name |
Description |
|
max_results |
Type: integer Maximum number of entities to be returned. Default: Min value: Max value: |
|
page_token |
Type: string Pagination token, can either be omitted or equal to |
Responses
200 OK
Success.
Body
application/json
{
"next_page_token": "string",
"results": [
{
"id": "string",
"number": "string",
"min": 0,
"max": 0,
"threshold_time": 0,
"comment": "string"
}
]
}
|
Name |
Description |
|
results* |
Type: SensorRange[] |
|
next_page_token |
Type: string If present, then there is a next page, and, to get the next page, this url can be called with |
SensorRange
|
Name |
Description |
|
max* |
Type: number<float> Maximum allowed value. Min value: Max value: |
|
min* |
Type: number<float> Minimum allowed value. Min value: Max value: |
|
number* |
Type: string Sensor range number. Used for syncing with the delivery company's system. Min length: Max length: Pattern: |
|
comment |
Type: string Description of the sensor-range. Max length: |
|
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). Min value: Max value: |
400 Bad Request
Invalid parameters were passed.
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.
No longer supported, please use an alternative and newer version.