Sign in

v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Subscribe to the location of a vehicle or an asset

post/v1/freight_visibility/subscribe

Query parameters

company_idstring

Specify the ID of the company to which the vehicle or the asset belongs.

dot_idstring

You must specify the DOT ID, if you not have the Company ID. Otherwise, it is not required.

asset_idstring

Specify the ID of the asset that you want to track.

vehicle_idstring

Specify the ID of the vehicle to be tracked.

vehicle_namestring

Specify the name of the vehicle that you want to track.

driver_idstring

Specify the ID of the driver whose vehicle location you are subscribing to.

start_timestring date required

Provide the start time from when you want to subscribe to a vehicle's location.

end_timestring date required

Provide the end time till when you want to subscribe to the vehicle's location.

load_idstring

Specify the ID of the load. Passed in by client for client side tracking. Sent back to client in response payload containing location.

load_detailsstring

Specify the details of the load. Passed in by client for client side tracking. Sent back to client in response payload containing location.

latnumber float

Specify the latitude coordinates of the initial load point.

lonnumber float

Specify the longitude coordinates of the initial load point.

Specify the coordinates of the starting point of load. This is mostly used for client side tracking.

latnumber float

Specify the latitude coordinates of the final drop point.

lonnumber float

Specify the longitude coordinates of the final drop point.

Specify the final drop off point of the vehicle. This is mostly for the tracking purposes of the client.

valuenumber float

Passed in by client for client side tracking. Sent back to client in response payload containing location.

unitstring

[“km”, “mi”] Passed in by client for client side tracking. Sent back to client in response payload containing location.

The total distance covered from the initial load point to drop off point.

trailer_idstring

Specify the ID of the trailer.

broker_namestring

The name of the freight broker who is tracking the load.

Response

200

Example response

{
  "data": {
    "tracking_subscription_id": 1426
  }
}