43.0 List Personnel (Z Pass / Ridership) Events

43.1 Request Data

Back to Index

This function retrieves personnel events from the system.

Note: This function is only available in version 2.X of the API.

cardtype

Type of card scans to return. Acceptable values are:

  • student – Return events for student card scans
  • driver – Return events for driver card scans (requires logvers 3).
  • both – Return events for both driver and student card scans (requires logvers 3).

Note: Default value is student for logvers <= 2. Default is
both for logvers >= 3.

InformationRequired
Name Description
action showevents
operation list
format xml
Optional Information
location Location to filter with. Text. If provided only data associated with assets assigned to this
location will be returned.
start Epoch timestamp. If specified only data with a timestamp after this time will be returned.
May be combined with end to specify a particular time period.
end Epoch timestamp. If specified only data with a timestamp before this time will be returned.
May be combined with start to specify a particular time period.
target Specific asset to report data for, rather than entire fleet. If specified then reqtype must be
specified as well. See asset target for details.
reqtype Flag to identify the key being used to query. Acceptable values:

  • tag Key is a Zonar RFID tag number. In version 2 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 id number. This is the most reliable key to use.
  • fleet Key is the asset fleet number. In version 2 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.
perstarget Filter output data by tag id. It is possible to have more than
one person’s scans returned if the cardtype = both and there is a rider
and driver card that share the same tag id.
tstype Determines which time stamp to filter by, valid options are:

  • log
  • load

Note: If tstype is not provided, tstype=log is assumed

logvers Determines what information is output, valid options are:

  • 1 – This is the standard output described below.
  • 2 – This will add a new child element to the event element named address. For XML example see below
  • 3 – This adds support for retrieving driver cards.

Note: If no value is passed, a default value of 1 is assumed.

Is this api manual documents helpful?
0 out of 0 said Yes
YesNo