HYhypertrack
Workers

Get Ops Group by Handle

Fetch ops group by ops_group_handle

get/workers/ops-groups/{ops_group_handle}

Request

Path parameters

ops_group_handlestring required

Query parameters

include_scheduleboolean

Flag to include ops group's schedule in the response.

Response

Successful response

ops_group_handlestring required

Unique identifier for an Ops Group

ops_group_labelstring required

Identifier label for an Ops Group

timezonestring required

IANA timezone of the Ops Group

route_start_locationstring

Configuration to identify where routes are expected to start

route_completion_typestring

Configuration to identify where routes are expected to end

objective_fnstring

Configuration to identify the metric used by the solver when generating optimized routes

default_shift_start_timestring

Default time HH:mm when the shift starts for drivers

default_shift_end_timestring

Default time HH:mm when the shift ends for drivers

route_capacityinteger required

Maximum number of orders in a route

route_max_distanceinteger required

Maximum distance in meters used by the resolver to constrain each route distance

deletedboolean

Flag to include deleted ops groups

deleted_atstring

Timestamp at which the OpsGroup was deleted

shift_availability_modestring required

Flag to start/stop availability of all drivers based on the ops group shift

order_tracking_modestring nullable

Order tracking mode associated with the ops-group

app_configobject nullable

Configuration specific to order's app

operations_radiusinteger nullable

Maximum distance in meters from the ops group home within which order destinations are allowed

enforce_operations_radiusboolean nullable

Whether to enforce operations_radius validation at order creation time

Changes

No recorded changes to this operation across all 1 revision of this API.