Get Ops Group by Handle

get https://v3.api.hypertrack.com/workers/ops-groups/{ops_group_handle}

Fetch ops group by ops_group_handle

Responses

Response body

object

ops_group_handle

string

required

Unique identifier for an Ops Group

ops_group_label

string

required

Identifier label for an Ops Group

timezone

string

required

IANA timezone of the Ops Group

route_start_location

string

Configuration to identify where routes are expected to start

route_completion_type

string

Configuration to identify where routes are expected to end

objective_fn

string

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

ops_group_home

object

Location of the Ops Group

geometry

object

required

Location of the Ops Group home

address

string | null

Defaults to null

Address for the Ops Group home

default_shift_start_time

string

Default time HH:mm when the shift starts for drivers

default_shift_end_time

string

Default time HH:mm when the shift ends for drivers

route_capacity

integer

required

Maximum number of orders in a route

route_max_distance

integer

required

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

deleted

boolean

Flag to include deleted ops groups

deleted_at

string

Timestamp at which the OpsGroup was deleted

shift_availability_mode

string

required

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

order_tracking_mode

string | null

Defaults to null

deprecated

Order tracking mode associated with the ops-group

schedule

array | null

Defaults to null

List of schedules used for ops group workers for work assignment and shift tracking

schedule

order_tracking_automation

object | null

A configuration object to enable/disable and customize automatic order tracking. Note that only the following are currently supported: {"type": "manual"}, {"type": "shift", "mode": "auto_stop"}, and {"type": "order", "mode": "auto_start"}. Please reach out to us if you would like to use the other configurations.

mode

string | null

Defaults to null

If auto_start, tracking will start based on the type. If auto_stop, tracking will stop based on the type. If auto, tracking will start and stop based on the type.

auto auto_start auto_stop

lead_time

integer | null

0 to 86399

Defaults to 0

If type is shift, this specifies the number of seconds before the driver's schedule's start_time to start tracking. If type is order, this specifies the number of seconds before the driver's first order's scheduled_at to start tracking.

lag_time

integer | null

0 to 86399

Defaults to 0

If type is shift, this specifies the number of seconds after the driver's schedule's end_time to stop tracking. If type is order, this specifies the number of seconds after the driver's last order is complete to start tracking. Note that tracking will not automatically stop while the driver has ongoing orders.

type

string

required

The type of order tracking automation to use. If order, tracking will start and stop based on the driver's orders. If shift, tracking will start and stop based on the driver's shift. If manual, tracking will not automatically start or stop. Note that the other fields are ignored when manual is used.

manual shift order

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://v3.api.hypertrack.com/workers/ops-groups/ops_group_handle \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

401Authentication error

404Not found

422Validation error