[OPTIONAL] Additional Position and Carrier Information

These are the bare-minimum requirements for creating a valid position event.

One of the features of a position event object is the ability to optionally add additional carrier information. The available optional parameters can be seen below:

Parameter

Type

Description

RemainingHours

Integer

The hours remaining, of an 11 hour driving limit, that the driver has remaining before a required break. (Used only to assist in ETA calculation)

PositionEventHeading

String

Direction the truck is heading at the time of the position event.

HasTeamDrivers

Boolean

0 = No
1 = Yes

Here is an example of a valid PositionEvent JSON Object with these additional position and carrier information added:

{
  "FreightProviderReferenceNumber":"12345678910",
  "FreightHaulerProviderXID":"TENFOURXID",
  "CarrierSCAC":"TEST",
  "CarrierMc":null,
  "CarrierDot":null,
  "StreetAddress1":"4750 W MOHAVE ST",
  "City":"PHOENIX",
  "PostalCode":"85043",
  "State":"AZ",
  "Country":"US",
  "PositionEventType":3,
  "PositionReportTime": "2018-08-20T18:52:22",
  "PositionEventHeading": "East",
  "RemainingHours": 10,
  "HasTeamDrivers": 1
}