25.0 Export a Path

25.1 Request Data

Back to Index

Exports a GPS path object for a specified target. Data returned as either standard KML log file or binary GPS log file.

Note: This operation is only supported in version 2.X.

Required Information
Name Description
action showposition
operation path
format kml or binary – binary is explained below
starttime Unix epoch timestamp
endtime Unix epoch timestamp
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.
Acceptable values are Standard or Trailer
version API protocol version – version 2 only
logvers 2
Optional Information
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.
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.
Is this api manual documents helpful?
0 out of 0 said YesYesNo