26.0 Current Location

26.1 Request Data

Back to Index

Export the last location of one or more assets. Data is returned as either standard KML log file or as a binary GPS log file.

Note: Only log version 3 is supported for binary current location requests. Log version 3.1 adds an odometer value in XML format only.

The following are parameters that are required and optional for these requests.

Required Information
Name Description
action showposition
operation current
format xml, kml or binary – binary is explained below
version API protocol version – version 2 only
logvers
  • 2 is available with format=xml or format=csv
  • 3 is only available with format=binary
  • 3.1 adds odometer value and is only available with format=xml
  • 3.2 formats the <time> value as epoch and is only available with format=xml
  • 3.3 adds GPS odometer offset value to odometer return value. Only available with format=xml
  • 3.4 Adds Exsid and Address to 3.2 results. Only available with format=xml
  • 3.5 Adds fuel_counter, fuel_level, rpm, source, and odometer offset to 3.2 results. Only available with format=xml
  • 3.6 Adds Address to 3.5 results. Only available with format=xml
Optional Information
target Identifies one particular asset according to reqtype.
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. In version 1.x type Standard (0) is assumed. See asset types for more details.
count The maximum number of results to return.

Note: Only valid for xml and kml
sortfield Field to sort results by. Acceptable values:

  • fleet is the fleet number.
  • lasttime is the last time stamp at the last location.
  • speed is the speed at the last location.
  • poweron is the status of the poweron bit.

Note: Only valid for xml and kml
sortdir Direction results are to be sorted by. Acceptable values:

  • asc
  • desc

Note: Only valid for xml and kml
startrow Can be used in combination with count to limit results to a subset. The subset will start at startrow and end at count.

Note: Only valid for xml and kml
power Filter results with power flag. Acceptable values:

  • on

Note: Only valid for xml and kml
loilocation A LOI1 name. If supplied, the distance from the asset to the center of this LOI is returned.
loifilter An LOI1 ID. If supplied, only assets within this LOI are returned.
loicatfilter An LOI1 Category ID. If supplied, only assets within this LOIs in this category are returned.
include_loi An LOI1 Set to ‘1’ to include the smallest GPS Zone (LOI) the asset is current in.
locname Filter by name of the location associated with the asset. If not used, all asset locations will be returned.
ztrak Indicates whether ZTrack units are returned by the current location request. Boolean data type with only two possible values: true or false.

 

1 LOI means Location of Interest; called “Zone” in the GPS tools and reports found within the Ground Traffic Control web application.

Is this api manual documents helpful?
0 out of 0 said YesYesNo