7.0 Get Aux Item(s)

7.1 Request Data

Back to Index

In version 1.X this function returns complete information for a specified aux object.
Version 2.X allows a complete list of all aux objects in the system to be returned, with location and type filtering.

Aux items represent some kind of minor (auxiliary) equipment to be inspected. Each aux item is uniquely identified by a type label and an RFID tag number combination. When inspected, an aux item may have an optional numeric value associated with it. This value is explained by the valuelabel defined by the aux type. For example aux items of type ‘DOLLY’ might have a valuelabel of miles, with the value representing the odometer reading at the time of inspection.

Version 2.X Required Information
Name Description
action showopen
operation aux
format xml
Optional Information
auxtype The type label of the requested item(s). DOLLY, TRAILER, etc. Must be an existing aux item type. Only aux items with this type will be returned. This may be combined with the ‘target’ to specify a specific object, or used on it’s own to produce a list of aux objects of the specified type.
target Zonar RFID Tag number of the requested item(s). Only items with the specified tag number will be returned. This may be combined with the ‘auxtype’ to specify a specific object, or used on it’s own to produce a list of aux objects with the specified tag number.
location Location to filter with. Text. If provided only aux items assigned to that location will be returned. If location is not supplied or an empty location is specified, aux items from all locations will be returned.
logvers Possible values:

  • 1 – Default output for 2.x without timestamp.
  • 2 – Appends the timestamp value if available.

Note: If no value is passed, 1 is assumed.

Version 1.X Required Information
Name Description
action extgetaux (Deprecated New clients should use 'showopen' with operation 'aux')
operation aux (Required if using the 'showopen' action.)
format xml (Required if using the 'showopen' action.)
auxtype The type label of the requested item. DOLLY, TRAILER, etc.
target Zonar RFID Tag number of the requested item.