Gets work breaks

  1. HTTP Request
  2. Path Parameters
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 401
    3. Code 403
    4. Code 404
    5. Code 422

Returns work breaks for route.

HTTP Request

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

Path Parameters

company_id *

integer

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

route_id *

integer

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

company_id *

integer

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

route_id *

integer

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

Responses

Code 200

Information about work breaks for the route was received.

[
  {
    "id": integer,
    "rest_duration_s": integer,
    "sequence_pos": integer,
    "work_time_range_till_rest": string
  }
]
Copied to clipboard

Representation

Collapse all
Expand all

Fields

id

integer

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

rest_duration_s

integer

Duration of rest, seconds.

Minimum value: 1.

sequence_pos

integer

Position of work break.

work_time_range_till_rest

string

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

id

integer

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

rest_duration_s

integer

Duration of rest, seconds.

Minimum value: 1.

sequence_pos

integer

Position of work break.

work_time_range_till_rest

string

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

Code 401

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

Code 403

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

Code 404

Object search error. Object not found.

Code 422

Incorrect input. The operation can't be performed.