25.0 Export a Path

25.1a Request Data – Log Version 3+

Back to Index
Required Information
Name Description
action showposition
operation path
format xml, json, csv, kml or binary – binary is explained below
version API protocol version – version 2 only
logvers The supported versions are:

  • 3 – adds support for multiple assets in a single file and a checksum
  • 3.1 – adds an odometer reading and asset exsid to the csv export
  • 3.2 – adds fuel data, acceleromter and status information
  • 3.3 – adds zone attribute to event element in XML
  • 3.4 – adds exsid attribute to asset element in XML
  • 3.5 – adds units in header for fuel and acceleration (CSV only)
  • 3.6 – adds Total Fuel Used, Outside Temp, Average RPM, Average Load, Fuel Level fields to output for CSV and XML (other fields appear in output but will not be populated)
  • 3.7 – adds fields for Outside Pressure, Peak RPM, Average Torque, Boost Pressure, Fuel Filter Diff Pressure, Air Filter Diff Pressure, DPF Diff Pressure, Regen Status Flags (CSV and XML))
  • 3.8 – adds source as ECM or GPS for data and returns new log reason 13 (panic) (CSV, XML and JSON only)
starttime Unix epoch timestamp
endtime Unix epoch timestamp
Optional Information
If any optional information is omitted, all asset data for the given start/stop time period will be returned
target The asset to query.
If specified a reqtype (request type) must be specified as well.
reqtype Flag to identify the key being used to identify the asset. Acceptable values:

  • tag Key is a Zonar RFID tag number. In version 2.X a type must also be specified.
  • exsid Key is the external system id.
  • vin Key is the Vehicle Identification Number (VIN).
  • dbid Key is the internal database id number. This is the most reliable key to use.
  • fleet Key is the asset fleet number. In version 2.X a type must also be specified.
type When using reqtype of tag or fleet this must also be specified in version 2. See asset types for more details.
tstype A flag to indicate what the starttime/endtime variables represent. Acceptable values are:

  • log Timestamp is the log point time. Log points after the starttime/before the endtime will be returned.
  • load Timestamp is the time the log point was added to the Zonar-Web system.  Log points that were uploaded after the starttime/before the endtime will be returned

If tstype is not specified, or is blank a value of ‘log‘ will be assumed.

tsformat A parameter to indicate the format for timestamps in the XML output. Default value if none is passed is iso8601

  • iso8601 Timestamp is formatted according to iso8601 standards, yyyy-mm-dd hh:mm:ss-timezone
  • epoch Timestamp is formatted as an epoch timestamp.

Note: If tsformat is not specified then a value of iso8601 will be assumed.

Note: tsformat is only used with format=xml

revgeocode A flag to indicate whether or not to reverse geocode the points returned. Acceptable values are:

  • true
  • false

If revgeocode is not specified, or is blank a value of ‘false‘ will be assumed.

Note: This is currently only applied to CSV exports. (Also in XML with logvers 3.8)

location Location to filter with. Text, the desired location name. If provided only positions data for assets assigned to that location will be returned.

You can find additional information on filtering your path results here.