10.0 Get Assets

10.2 Data Returned

Back to Index
Returned information

A list of assets.

DTD

<!ELEMENT assetlist (asset*)> <!ATTLIST assetlist ver CDATA #REQUIRED>
<!ELEMENT asset (name, tag, vin, fleet, exsid, type, subtype, mileage, location,
mileoffset, radioaddress, mfg, inservice, inspdate, yardstat, opstatus, homeloi, zid, customdata*)>
<!ATTLIST asset id CDATA #REQUIRED>
<!ELEMENT name (#PCDATA)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT vin (#PCDATA)>
<!ELEMENT fleet (#PCDATA)>
<!ELEMENT type (#PCDATA)>
<!ATTLIST type id CDATA #REQUIRED>
<!ELEMENT subtype (#PCDATA)>
<!ATTLIST subtype id CDATA #REQUIRED>
<!ELEMENT exsid (#PCDATA)>
<!ELEMENT mileage (#PCDATA)>
<!ELEMENT location (#PCDATA)>
<!ELEMENT mileoffset (#PCDATA)>
<!ELEMENT enginehouroffset (#PCDATA)>
<!ELEMENT radioaddress (#PCDATA)>
<!ELEMENT mfg (#PCDATA)>
<!ELEMENT inservice (#PCDATA)>
<!ELEMENT inspdate (#PCDATA)>
<!ATTLIST inspdate id CDATA #IMPLIED>
<!ATTLIST inspdate type CDATA #IMPLIED>
<!ELEMENT yardstat (yard, stat)>
<!ELEMENT yard (#PCDATA)>
<!ELEMENT stat (#PCDATA)>
<!ATTLIST stat timestamp CDATA #REQUIRED>
<!ELEMENT status (#PCDATA)>
<!ELEMENT opstatus (#PCDATA)>
<!ATTLIST opstatus timestamp CDATA #IMPLIED>
<!ELEMENT gps (#PCDATA)>
<!ELEMENT homeloi (#PCDATA)>
<!ELEMENT zid (#PCDATA)>
<!ELEMENT customdata (label*)>
<!ELEMENT label>
<!ATTLIST label id CDATA #REQUIRED>
<!ATTLIST label name CDATA #REQUIRED>
<!ATTLIST label value CDATA #REQUIRED>

Reply Data
Name Description
id (asset) The internal database identifier for the asset object. This is the primary means of identifying an asset and how the asset is linked to other objects.
name An arbitrary text string of up to 20 characters in length. Usually labeled as ‘License Plate Number:’ in the web interface. It is not required to be unique.
tag The Zonar RFID tag number assigned to the asset. Coupled with the Type, this is usually the means by which an asset is identified in an inspection. The combination of tag number and type must be unique for each asset. May be zero.
vin An arbitrary text string of up to 40 characters in length. If the asset is a vehicle this is intended to be the VIN (Vehicle Identification Number) for the asset. Each asset must have a unique VIN.
fleet Fleet number. An arbitrary text string of up to 20 characters in length. If the asset is a vehicle this is intended to be the user assigned identification for the vehicle. This is usually labeled ‘Asset No.’ in the web interface. The combination of fleet number and type must be unique for each asset. All assets must have a fleet number.
type The asset type identifier. The combination of tag number and type or fleet number and type is used to uniquely identify the asset. Text, 32 characters maximum length. All assets have a type.
id (type) The numeric type value.
subtype An arbitrary user assigned label for the kind asset. Used to help organize and group assets. Text, 32 characters maximum length, may be empty.
id (subtype) The internal database id for the subtype.
exsid External System Identifier (EXSID). An arbitrary text string of up to 40 characters in length. Intended for use a unique asset identifier by external systems. The EXSID must be unique for each asset. May be empty.
mileage Current (mileage) value. The last reported value for the asset. Taken from the latest inspection. Although labeled ‘mileage’ it may refer to hours of operation, or any other numeric value for the asset.
location The location the asset is assigned to.
mileoffset A numeric value to be applied to incoming mileage values from inspections if the value comes from a hubometer or similar device. These devices are typically programmed with an initial value which may or may not agree with the value for the vehicle it is attached to. This offset is used to correct the hubometer value to the correct reading when the inspection report is loaded into the system. This is the only time the offset is used. A signed integer quantity, may be zero.

Note: Although labeled ‘mileage’ this value may relate to any other unit such as kilometers or hours of operation.

radioaddress Numeric. Evirnet radio address assigned to this asset. If used, must be unique. May be zero.
mfg Manufacturer. An arbitrary text string of up to 20 characters in length identifying the maker of the asset. May be empty.
inservice Inservice date. The date the asset entered service.
inspdate The timestamp of the last reported inspection for this asset. May be an empty element if the asset has no inspections. Unix epoch timestamp (UTC) if present.
id (inspdate) The inspection id number for the last reported inspection.
type (inspdate) The inspection type label for the last reported inspection. Text, 32 characters maximum length.
yard (yardstat) The label of the last radio base station location that reported the asset as in or out of range. Text, 32 characters maximum length, may be empty if the asset yard status has not been reported.
stat (yardstat) The yard (radio) status of the asset. Indicates whether the asset is in range of a radio base station or not. Possible values are:

  • in The asset is in range of a radio base station.
  • out The asset is not in range of any radio base station.
  • unknown The asset yard status has not been reported.
timestamp (stat) Timestamp of when the asset yard status last changed. Unix epoch timestamp (UTC) if present.
status Shows whether the asset is in an active/inactive status.

  • 1. The asset is active, normal status.
  • 2. Used to show revocation of an asset.
opstatus Operational status.
The assets fitness for duty, as determined by inspection. Possible values:

  • unknown Asset has not been inspected.
  • good Asset has been inspected and has no unrepaired defects.
  • unsat Asset has been inspected and has un repaired non critical defects.
  • crit Asset has been inspected and has un repaired critical defects. Asset is out of service.
 timestamp (opstatus)  Timestamp of when the asset operational status last changed. Unix epoch timestamp (UTC) if present. Will be zero if the operational status is unknown.
 gps  The GPS unit serial number if the asset has one. A 32 bit unsigned numeric value.
 homeloi  home LOI1 for this asset.
 zid  Available in version 2 The ID of the ZCon truck board device installed in the asset.
 customdata  Available in version 3 Arbitrary custom data labels that are associated to the asset.

 

Note: The <inspdate> element contains the Unix epoch timestamp of the latest inspection for this asset. The id attribute is the inspection id. If the asset has no inspections, then the element is empty, like this: <inspdate/> This element was added in API protocol version 1.03.

The <inservice> date element and <mfg> element were added in API protocol version 1.03.

The <yardstat> element and inspection config information were added in API protocol version 1.05.

The <opstatus> element was added was added in protocol version 1.06. See the request data for an explanation of the different values.
The id attribute was added was added in protocol version 1.06. This is the internal system id of the asset object.

The <type> and <subtype> elements were added in protocol version 1.07.

The <mileage> element is the last reported mileage value for that asset. To determine elapsed mileage for an asset use the mileage reporting function.

Example Request

http://development.zonarsystems.net/interface.php?action=showopen&operation=showassets&format=xml

Example Success Reply

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