Click or drag to resize
POST /locations
Print this page

This service is used to insert locations (points) into the system. It submits GPS points, which give the location and status of a vehicle at specific times.


For any Location object:

  • If the unitId is specified in the Location object, then it is used.
  • If serialNumber and unitType are supplied, then the unitId is determined using those values.
  • Otherwise, the unitId of the current user's driver is assumed.
The Request body is a JSON array of location objects to insert:
Member Type Purpose
unit_id string (optional) Identifies the vehicle that was at the location.
driver_id string Identifies the driver that was at the location.
time string The ISO 8601 timestamp for when the point was generated.
tag string The name of the vehicle at the location.
vin string The VIN (vehicle identification number) of the vehicle at the location.
lat string The latitude of the location, in decimal degrees.
lon string The longitude of the location, in decimal degrees.
gpsQuality string The quality of the GPS fix. Values: (0) Off, (1) NoFix, (2) Unreliable, (3) Excellent. Use the number or the word for the value.
speed string The speed of the vehicle, in kilometers per hour.
heading string The heading (direction) of the vehicle, in degrees (0 is north, 90 is east).
serialNumber string (optional) The serial number of the device installed in the vehicle that was at the location. Note that, if unit_id is not specified, this field is used along with unitType to identify the vehicle. If neither unit_id nor serialNumber and unitType are specified, then the unit is assumed to be the one currently assigned to driver that is currently logged in.
unitType string (optional) The type of unit hardware installed in the vehicle that was at the location.
ignition string True (1) if the ignition is on; false (0) if not.


On success, the response body contains a JSONStatus object. The only entry in the JSONStatus object will be the "accepted" entry, which indicates the number of locations accepted and published.

If the request fails, an Error Response is generated.