10.0 Get Assets

10.1 Request Data

Back to Index

Returns a list of assets in the system.

Note: This action was added to protocol version 1.01.

Required Information
Name Description
action showopen
operation showassets
format xml
Optional Information
logvers Available versions are 1, 2 and 3.
location Location to filter with. Text. If provided only assets assigned to that location will be returned. If location is not supplied or an empty location is specified, assets from all locations will be returned.
modifytime Only return assets that have been modified on or later than this time. A Unix epoch time stamp.
A change to any of the name, tag, vin, fleet, exsid, location, mileoffset, radioaddress, mfg or inservice attributes will change the modify timestamp.

Note: modifytime and yardstat are mutually exclusive, only one or the other may be specified.

status Only return assets with the specified asset status. Possible values are 1 active or 2 inactive.

  • 1 Active. The asset is active, normal status.
  • 2 Inactive. Used to show revocation of an asset.
yardstat Only return assets with the specified yard status. Possible values are ‘in’, ‘out’ and ‘unknown’.

Note: modifytime and yardstat are mutually exclusive, only one or the other may be specified.

opstatus Only return assets with the specified operational status. Possible values are 'good', 'unsat', 'crit' and 'defect'.

  • good Assets that have been inspected and have no unrepaired defects.
  • unsat Assets that have been inspected and have unrepaired non critical defects.
  • crit Assets that have been inspected and have unrepaired critical defects. In other words the asset is not fit for service.
  • defect Assets with either 'unsat' or 'crit' status.

Note: This was added in protocol version 1.0.6.

target Query for a specific asset and only return information for that asset.
If specified a reqtype (request type) must be specified as well. This option may not be used in combination with modifytime, location or yardstat.
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.

Note: In version 1.x type is passed as the DBID of the asset type
Note: In version 2.x type is passed as the string name of the asset type e.g. Standard or TRAILER