37.0 GPS Schedule Report

37.1 Request Data

Back to Index

Returns a schedule report of what locations of interest have been intersected by assets. Data is returned in either CSV or XML format.

Required Information
Name Description
action showposition
operation schedule
format The format to return results in. Acceptable values:

  • xml Results are returned in an XML format.
  • csv Results are returned as a series of comma separated values.
starttime Unix epoch timestamp.
endtime Unix epoch timestamp.
reporttype The type of report to create. Acceptable values:

  • 1 Report for a single asset, the report will consist of each location of interest1 the asset visited in the specified time period.
  • 2 Report for a single location of interest1. The report will consist of every asset that visited the specified location in the requested time period.

If reporttype is not specified, or is blank a value of ‘1’ will be assumed.

target When reporttype is 1, this value represents the asset.
When reportype is 2, this value represents the location of interest.
If specified a reqtype (request type) must be specified as well.
reqtype Flag to identify the key being used to identify the asset or location of interest target.
When reporttype is 1, this value represents the key for an asset. Acceptable values:

  • tag Key is a Zonar RFID tag number. 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. A type must also be specified.

When reportype is 2, this value represents the key for a location of interest. Acceptable values:

  • dbid Key is the internal database id number. This is the most reliable key to use.
  • name Key is the location of interest name.
type When using reqtype of tag or fleet this must also be specified. See asset types for more details.

Note: type is only evaluated when passed with version=2

Request Data for log version 2
Required Information
Name Description
action showposition
operation schedule
format The format to return results in. Acceptable values:

  • xml Results are returned in an XML format.
  • csv Results are returned as a series of comma separated values.
starttime Unix epoch timestamp.
endtime Unix epoch timestamp.

Note: Time limit is limited to 15 minutes for this version of the call

logvers 2 – This will run the report for all assets against all zones.

 

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