24.0 GPS Idle/Stop Report

24.1 Request Data

Back to Index

Returns a list of idle/stop times for assets that meet the given filter restrictions. Data returned is similar to the GPS Idle/Stop Report results returned on the website.

There are 2 types of requests for the idle and stop times. These requests match the 2 different types of result tables displayed in the GPS Idle/Stop Report on the website. The first request type displays the idle/stop totals, which is a summary of all the idle and stop times. The second request type displays a list of all the idle or stop times for a single asset. In version 2, the long/lat output values are swapped.

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

Idle/Stop “Totals” Request
Required Information
Name Description
action showposition
operation idlestoptotals
format xml
fromdate epoch time. Results will be from events that occurred during or after this time.
todate epoch time. Results will be from events the occurred during or before this time.
Optional Information
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.
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.
loiinclude Flag to notate if the results should only be inside or outside of the given location of interest. Acceptable values:

  • include Include results only within given loi. loi1location must be used.
  • exclude Exclude results within given loi. loi1location must be used.
loilocation When using loi1include, query for results that only occurred within or outside a specific location of interest. Value must be a location of interest name.
idletimecomp Component to notate if idle/stop times must be shorter than or longer than the given time length. Acceptable values:

  • > Only show idle/stop times longer than the given time length. idletime must be used.
  • < Only show idle/stop times shorter than the given time length. idletime must be used.
idletime When using idletimecomp, only show idle/stop times shorter than or longer than this time length. Valid format is:

  • HH:MM:SS Time period must contain 2 digits for Hours, Minutes and Seconds, separated by colons e.g. 00:05:30
tstype A flag to indicate what the starttime/endtime variables represent. If nothing is passed log is assumed. Acceptable values are:

  • log Timestamp is the log time for the idle/stop event.
  • load Timestamp is the time that the idle/stop event was added to the Zonar-Web system. Events added between fromdate/todate will be returned.
Idle/Stop “All” Request
Required Information
Name Description
action showposition
operation idlestopallidle or idlestopallstop. idlestopallidle shows all idle times and idlestopallstop shows all stop times.
format xml
fromdate epoch time. Results will be from events that occurred during or after this time.
todate epoch time. Results will be from events the occurred during or before this time.
Optional Information
target Query for a specific asset and only return information for that asset. If specified a reqtype (request type) must be specified as well.

Please note that if not specified then all assets will be shown in the specified date range.

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.
loiinclude Flag to notate if the results should only be inside or outside of the given location of interest. Acceptable values:

  • include Include results only within given loi1. loi1location must be used.
  • exclude Exclude results within given loi1. loi1location must be used.
loilocation When using loi1include, query for results that only occurred within or outside a specific location of interest. Value must be a location of interest name.
idletimecomp Component to notate if idle/stop times must be shorter than or longer than the given time length. Acceptable values:

  • > Only show idle/stop times longer than the given time length. idletime must be used.
  • < Only show idle/stop times shorter than the given time length. idletime must be used.
idletime When using idletimecomp, only show idle/stop times shorter than or longer than this time length. Valid format is:

  • HH:MM:SS Time period must contain 2 digits for Hours, Minutes and Seconds, separated by colons e.g. 00:05:30
tstype A flag to indicate what the starttime/endtime variables represent. If nothing is passed log is assumed. Acceptable values are:

  • log Timestamp is the log time for the idle/stop event.
  • load Timestamp is the time that the idle/stop event was added to the Zonar-Web system. Events added between fromdate/todate will be returned.

 

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 Yes
YesNo