Patch Driver

patch https://v3.api.hypertrack.com/drivers/{driver_handle}

Update driver information using the driver_handle

Path Params

driver_handle

string

required

Body Params

device_id

uuid | null

Defaults to null

Unique ID representing the driver's device

name

string | null

Defaults to null

Name of the driver

ops_group_handle

string | null

Defaults to null

Unique identifier for an Ops Group to which the driver belongs

home

object | null

Driver's home location

product_types

array of strings | null

Defaults to null

List of product types used for driver matching during order planning

product_types

schedule

array | null

Defaults to null

List of schedules used for driver matching during order planning and auto start/stop of availability or tracking of the driver

schedule

profile

object | null

Additional customer provided data associated with a driver

unavailable_on

array of strings | null

Defaults to null

List of dates (YYYY-MM-DD) on which the driver is unavailable

unavailable_on

transfer_existing_work

boolean | null

Defaults to null

Flag to indicate whether existing work of the driver is to be transferred to the newly linked device.Only applicable at the time of linking driver with a device.

Responses

Response body

object

driver_handle

string

required

Unique customer provided identifier for a driver

name

string | null

Defaults to null

Name of the driver

ops_group_handle

string

required

Unique identifier for an Ops Group to which the driver belongs

product_types

array of strings

required

List of product types used for driver matching during order planning

product_types*

device_id

string | null

Defaults to null

Unique ID representing the driver's device

profile

object

required

Metadata associated with a driver

Has additional fields

work_status

object

required

work_status of the driver with respect to availability and on order fulfilment

tracking

boolean

required

Flag indicating whether the driver is currently on work

available

boolean

required

Flag indicating if the driver is available for work

schedule

array | null

Defaults to null

List indicating the schedule of a driver for work assignment

schedule

deleted

boolean | null

Defaults to null

Flag indicating whether the driver was deleted

created_at

string

required

Timestamp at which the driver was created

home

object

required

Driver home

address

string | null

Defaults to null

Address for the location

geometry

object

required

Location geometry

deleted_at

string | null

Defaults to null

Timestamp at which the driver was deleted

location

object | null

Last known location of the driver

geometry

object

required

Location geometry

accuracy

number | null

Defaults to null

Accuracy in meters for the location

bearing

number | null

Defaults to null

Directional position in degrees for the location

speed

number | null

Defaults to null

Speed in meters per second at this location

recorded_at

string | null

Defaults to null

Timestamp associated with the last known location of the worker.

device_status

object | null

Current status of the device used by the driver

value

string

required

Status of the driver's device - active disconnected inactive available unavailable

data

object

required

Data associated with the driver's device status - reason, activity

Has additional fields

unavailable_on

array of strings

required

List of dates (YYYY-MM-DD) on which the driver is not available

unavailable_on*

summary

object | null

Summary of work done by the driver during the specified time range. Default last 24 hours.

orders

object

required

Summary of orders fulfilled by the driver in the specified time range.

geotags

integer

required

Number of Geotags created by the driver in the specified time range.

visits

integer

required

Number of Visits made by the driver during the specified time range.

intended_track_duration

integer

required

Total duration (in seconds) for which the driver was supposed to be tracked during the specified time range.

outage_duration

integer

required

Total duration (in seconds) for which the driver could not be tracked (in outage) during the specified time range.

outage_distance

integer

required

Total estimated distance (in meters) covered by the driver while he/she could not be tracked during the specified time range.

outage_summary

array of objects

required

List of outages experienced by the driver during the specified time range.

outage_summary*

object

code

string

required

Code indicating the type of outage

label

string

required

Text indicating the type of outage

description

string

required

Text describing the outage.

category

string

required

String indicating the category of outage

behavioural adversarial reachability os sporadic

duration

integer

required

Sum total duration of all outages experienced with this code in the specified time range.

distance

integer

required

Sum total (estimated) distance covered during all outages experienced with this code in the specified time range.

tracked_duration

integer

required

Total duration (in seconds) for which the driver was actually tracked during the specified time range.

tracked_distance

integer

required

Total distance (in meters) driven by the driver while the driver was actually tracked during the specified time range.

avg_distance_per_visit

number

required

Average distance (in meters) driven by the driver per visit while the driver was actually tracked during the specified time range.

drive_duration

integer

required

Total duration (seconds) for which the driver was driving during the specified time range.

walk_duration

integer

required

Total duration (seconds) for which the driver was walking during the specified time range.

stop_duration

integer

required

Total duration (seconds) for which the driver had stopped during the specified time range.

order_duration

integer

required

Total duration (seconds) which the driver had spent delivering orders.

visit_duration

integer

required

Total duration (seconds) which the driver had spent doing visits.

geotag_duration

integer

required

Total duration (seconds) which the driver had spent creating geotags.

tracking_rate

number | null

Defaults to null

Average tracking rate of the driver during the specified time range.

distance

integer | null

Defaults to null

Total distance (tracked + outage) in meters covered by the driver during the specified time range.

available_duration

integer | null

Defaults to null

deprecated

Total duration (in seconds) for which the driver was actually tracked during the specified time range.
Please use the field tracked_duration instead.

work_duration

integer | null

Defaults to null

deprecated

Total duration (seconds) spent on work by the driver in the specified time range.

status

object

required

Flags indicating driver's work status during the specified time range.

location_permission

object | null

Last known location permission on the driver's device

state

string

required

State of location permission

always foreground_only never unknown

recorded_at

string | null

Defaults to null

Time stamp of the last known location permission

device_info

object | null

Information of the Device associated with Driver

timezone

string

required

Timezone of the device

os_name

string

required

Operating system running on the device

device_brand

string

required

Brand of the device

sdk_version

string

required

HyperTrack SDK version used on the device

device_model

string

required

Model of the device

network_operator

string

required

Network operator used by the device

os_version

string

required

Operating system version on the device

os_hardware_identifier

string

required

Hardware identification number for the device

app_name

string

required

App name on the device

app_version_string

string

required

App version used on the device

app_version_number

string

required

App version number used on the device

battery

object | null

Information of the battery status.

battery_percent

integer

required

Integer indicating the percent of charge on the battery.

recorded_at

string

required

Timestamp of the reading

timezone

string | null

Defaults to null

Timezone of the driver

Language

Credentials


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://v3.api.hypertrack.com/drivers/driver_handle \
3
     --header 'accept: application/json' \
4
     --header 'content-type: 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