v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Scheduling

Get Routes

Retrieves a list of routes based on various query parameters, such as OperatorId, DriverId, Status, and multiple search options (e.g., by Name, Code, Notes, etc.).

get/v1/Scheduling/routes

Query parameters

OperatorIdinteger

The unique identifier of the operator associated with the routes.

DriverIdstring uuid

The unique identifier of the driver assigned to the routes.

Statusinteger

The status identifier of the routes to filter the results.

Searchstring

A search string used to find routes based on various fields.

SearchByNameboolean

Indicates whether to search by route name.

SearchByCodeboolean

Indicates whether to search by route code.

SearchByNotesboolean

Indicates whether to search by route notes.

SearchByRouteIdboolean

Indicates whether to search by route ID.

Response

A list of routes that match the specified criteria.

DistributorIdinteger

The unique identifier of the distributor associated with the routes.

OperatorIdinteger

The unique identifier of the operator associated with the routes.

OperatorNamestring nullable

The name of the operator associated with the routes.