Status Operational Status

Path Summary

  • Last edited on

Use this to get path summary information for assets that have moved within a specified time period. For example to find assets that have been used over a weekend.

Required Information
Name Description
action showposition
operation pathsummary
format The format to return results in. Acceptable values:
  • xml Results are returned in XML format.
  • json Results are returned in JSON format.
starttime Epoch timestamp. Earliest time to get data from.
endtime Epoch timestamp. Latest time to get data from.

In future releases there may be a 15 day limit on the date selection.
Optional Information
Name Description
target Query for a specific asset and only return information for that asset. 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.

Returned information

XML DTD

<!ELEMENT pathsummary (asset*)>

WITH XML ADD

<!ATTLIST pathsummary ver CDATA #REQUIRED> <!ATTLIST pathsummary assetcount CDATA #REQUIRED> <!ELEMENT asset (start, end, odometer, max_speed, max_idle, max_stop)>
<!ATTLIST asset id CDATA #REQUIRED>
<!ATTLIST asset fleet CDATA #REQUIRED>
<!ATTLIST asset type CDATA #REQUIRED>
<!ATTLIST asset tag CDATA #REQUIRED>
<!ATTLIST asset exsid CDATA #REQUIRED> <!ELEMENT start (#PCDATA)>
<!ATTLIST start lon CDATA #REQUIRED>
<!ATTLIST start lat CDATA #REQUIRED>
<!ATTLIST start zone CDATA #REQUIRED> <!ELEMENT end (#PCDATA)>
<!ATTLIST end lon CDATA #REQUIRED>
<!ATTLIST end lat CDATA #REQUIRED>
<!ATTLIST end zone CDATA #REQUIRED> <!ELEMENT odometer (#PCDATA)>
<!ATTLIST odometer min CDATA #REQUIRED>
<!ATTLIST odometer max CDATA #REQUIRED> <!ELEMENT max_speed (#PCDATA)>
<!ATTLIST max_speed lon CDATA #REQUIRED>
<!ATTLIST max_speed lat CDATA #REQUIRED> <!ELEMENT max_idle (#PCDATA)>
<!ATTLIST max_idle lon CDATA #REQUIRED>
<!ATTLIST max_idle lat CDATA #REQUIRED> <!ELEMENT max_stop (#PCDATA)>
<!ATTLIST max_stop lon CDATA #REQUIRED>
<!ATTLIST max_stop lat CDATA #REQUIRED>

WITH JSON ADD

<!ELEMENT event bbox (sw*, nw*)>
<!ELEMENT event sw (x, y)>
<!ELEMENT event x CDATA #REQUIRED>
<!ELEMENT event y CDATA #REQUIRED>
<!ELEMENT event ne (x, y)>
<!ELEMENT event x CDATA #REQUIRED>
<!ELEMENT event y CDATA #REQUIRED>
--
Reply Data
Name Description
version - (XML ONLY) The version number of the API call and return data.
assetcount The number of results returned.
Asset id The internal identifier for the asset.
Asset fleet The fleet identifier for the asset.
Asset tag The Zonar Tag id for the asset.
Asset exsid The external system identifier for the asset.
Start lon The longitude of the first point in the requested time period.
Start lat The latitude of the first point in the requested time period.
Start Zone The GPS Zone of the first point in the requested time period.
End lon The longitude of the last point in the requested time period.
End lat The latitude of the last point in the requested time period.
End Zone The GPS Zone of the last point in the requested time period.
Odometer min The odometer of the first point in the requested time period.
Odometer max The odometer of the last point in the requested time period.
Max Speed lon The longitude of the max speed in the requested time period.
Max Speed lat The latitude of the max speed in the requested time period.
Max Speed Zone The GPS Zone of the max speed in the requested time period.
Max Idle lon The longitude of the max idle in the requested time period.
Max Idle lat The latitude of the max idle in the requested time period.
Max Idle Zone The GPS Zone of the max idle in the requested time period.
Max Stop lon The longitude of the max stop in the requested time period.
Max Stop lat The latitude of the max stop in the requested time period.
Max Stop Zone The GPS Zone of the max stop in the requested time period.
Bounding Box - (For Maps JSON ONLY)
SW
  • X Coord
  • Y Coord
NE
  • X Coord
  • Y Coord

Example XML Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showposition&operation=pathsummary&format=xml&customer=abc1234&start=1141397988&end=1141398000

Example JSON Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showposition&operation=pathsummary&format=json&customer=abc1234&start=1141397988&end=1141398000

Example XML Success Reply

<?xml version="1.0"?>
<pathsummary ver="3" assetcount="2">
 <asset id="310" fleet="33066" tag="33066" exsid="33066">
 <start lon="-80.2592317" lat="26.1061702" zone="">2009-08-06 13:55:45-07</start>
 <end lon="-80.2593043" lat="26.1061782" zone="">2009-08-19 15:03:26-07</end>
 <odometer min="146" max="173">27.5</odometer>
 <max_speed lon="-80.167172" lat="26.0151507">34219</max_speed>
 <max_idle lon="-80.2592929" lat="26.1061153">00:13:12</max_idle>

<max_stop lon="-80.2592137" lat="26.1061614">281:34:37</max_stop>
 </asset>
 <asset id="481" fleet="Andy_1002263" tag="" exsid="">
 <start lon="-122.2483156" lat="47.4374376" zone="">2009-08-21 10:37:28-07</start>
 <end lon="-122.2479482" lat="47.4375965" zone="">2009-08-21 10:46:57-07</end>
 <odometer min="355" max="355">0.0</odometer>
 <max_speed lon="-122.2479482" lat="47.4375965">0</max_speed>

<max_idle lon="" lat="">00:00:00</max_idle>
 <max_stop lon="" lat="">00:00:00</max_stop>
 </asset>
</pathsummary>

 

GPS Track and Trace

See more