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
Request
- Base URLhttps://example.com:443
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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.
Changes
No recorded changes to this operation across all 1 revision of this API.