23.0 GPS Mileage Report

23.1 Request Data

Back to Index

Returns a list of distances travelled by assets that meet the given filter restrictions. Data returned is similar to the GPS Mileage Report results returned on the website. When returning all assets, there are two formats for displaying the results: all assets combined into one result, or all assets listed separately (described more below under target).

The following is a list of parameters that are required and optional for this request.

Required Information
Name Description
action showposition
operation mileage
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.
Note:In future releases there may be a 15 day limit on the date selection.
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.

Note: there are two ways to select results for all assets. The default way (using no target) returns a result for each asset separately.The second way (using a target of -1 and a reqtype of dbid) returns 1 result of all assets combined.

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.
LOI1 location Query for results that only occurred within a specific location of interest. Value must be a location of interest name.

Note: LOI Location and LOI Category are mutually exclusive, only one or the other may be specified.

LOI1 category Query for results that only occurred within locations of interest1 belonging to a specific category. Value must be a location of interest category name.

Note: LOI Location and LOI Category are mutually exclusive, only one or the other may be specified.

 

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