Gets work breaks

Returns work breaks for route.

Request

GET

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

Path parameters

Name

Description

company_id*

Type: integer

Company ID used in requests to the Track & Trace API.

route_id*

Type: integer

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

Responses

200 OK

Information about work breaks for the route was received.

Body

application/json
[
    {
        "id": 0,
        "sequence_pos": 0,
        "rest_duration_s": 0,
        "work_time_range_till_rest": "string"
    }
]

WorkBreak[]

WorkBreak

Name

Description

id

Type: integer

Work break ID used in requests to the Track & Trace API.

rest_duration_s

Type: integer

Duration of rest, seconds.

Min value: 1

sequence_pos

Type: integer

Position of work break.

work_time_range_till_rest

Type: string

Minimal and maximal duration of work before rest, format: [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]].

401 Unauthorized

Deprecated

Authorization error. Make sure that the request header contains the correct OAuth token.

403 Forbidden

Deprecated

Error accessing the object. The user doesn't have the rights to access the object.

404 Not Found

Deprecated

Object search error. Object not found.

422 Unprocessable Entity

Deprecated

Incorrect input. The operation can't be performed.