5.0 Get Inspection Details

5.2 Data Returned

Back to Index
Returned information

Note: The ffd element is fitness for duty, it will be either true or false. This indicates whether the defect prevents safe operation of the asset. If true the asset may be used safely without repairing the defect.

Note: The zone status attribute describes the inspection status of the zone it is attached to. Possible values are:

  • UN Unknown, the zone has not been inspected.
  • ZOV Zone Ok Verified, the zone has been inspected, found to be ok and verified with the 2010 hand held device.
  • ZBV Zone Bad Verified, the zone has been inspected, found to have defects and verified with the 2010 hand held device.
  • ZONV Zone Ok Not Verified,the zone has been manually inspected and found free of defects. The inspection has not been verified by reading a tag.
  • ZBNV Zone Bad Not Verified,the zone has been manually inspected and found to have defects. The inspection has not been verified by reading a tag.

Note: The storetime and loadlocation elements may be empty. If so they will be presented in the standard format for an empty XML element like this: <storetime/> <loadlocation/>

Note: The source element describes the device used to extract the inspection from the Zonar 2010 hand held device. Possible values are:

  • NA Extractor device information not available.
  • RDS Inspection was extracted by a Zonar RDS.
  • RAD Inspection was extracted by a Zonar Evirnet radio device.
  • MOD Inspection was extracted by a Zonar Evircom modem.
  • ED Inspection was created by a manual editing system. It did not originate from a 2010 device.
  • TST Inspection was created by a testing program. It did not originate from a 2010 device.

Note: The data elements have been added in version 2.07 / 1.12. This is how any arbitrary data included in the inspection will be presented. The data may be associated with an asset, zone or aux item. The data consist of three elements, a name essentially a label identifying the piece of data, a type indicating what kind of data it is see below for details and the data value itself.
Data types described below:

  • INT The data is an integer (whole number) value.
  • FLOAT The data is a floating point (fractional number) value.
  • STRING The data is a string of characters, maximum length 255.
  • UNKNOWN The data type is unknown. This should never be seen.

Note: The signature status element has been added in version 2.07 / 1.12. This indicates the status of the return SSL certificate signature.
Possible values are:

  • VAL Valid signature.
  • NOS No signature.
  • INV Invalid signature.
  • EDF Signature decode failed.
  • NOT Signature not checked.
  • EOK Failed to open public key (internal error, should not be seen).
  • ERK Failed to read public key (internal error, should not be seen).
  • EEK Failed to extractpublic key (internal error, should not be seen).
  • EVF Verify failed (internal error, should not be seen).

Important: The structure of this reply has changed in protocol version 2. Version 2 responses must allow for the possibility of multiple assets per inspection and are incompatible with version 1.X responses. See Appendix d. for more detailed information about API versioning.

DTD (Version 1.X)

<!ELEMENT inspinfo (inspid, date, storetime, fleet, stat, mileage, operator, loadlocation, zone*, aux*, data*)>
<!ATTLIST inspinfo ver CDATA #REQUIRED>
<!ELEMENT inspid (#PCDATA)>
<!ELEMENT date (#PCDATA)>
<!ELEMENT storetime (#PCDATA)>
<!ELEMENT fleet (#PCDATA)>
<!ELEMENT stat (#PCDATA)>
<!ELEMENT mileage (#PCDATA)>
<!ELEMENT operator (#PCDATA)>
<!ELEMENT loadlocation (#PCDATA)>
<!ELEMENT source (#PCDATA)>
<!ELEMENT sn (#PCDATA)>
<!ELEMENT firmware (#PCDATA)>
<!ATTLIST config ver CDATA #REQUIRED>
<!ELEMENT config (#PCDATA)>
<!ELEMENT sigstate (#PCDATA)>

<!ELEMENT zone (defect*, data*)>
<!ATTLIST zone name CDATA #REQUIRED>
<!ATTLIST zone timestamp CDATA #REQUIRED>
<!ATTLIST zone status (UN | ZOV | ZBV | ZONV | ZBNV) "UN">
<!ELEMENT defect (component, condition, ffd, defectid, repair*, pending*)>
<!ELEMENT component (#PCDATA)>
<!ELEMENT condition (#PCDATA)>
<!ELEMENT ffd (#PCDATA)>
<!ELEMENT defectid (#PCDATA)>
<!ELEMENT repair (agent, date, repid, orderno, note)>
<!ELEMENT agent (#PCDATA)>
<!ELEMENT date (#PCDATA)>
<!ELEMENT repid (#PCDATA)>
<!ELEMENT orderno (#PCDATA)>
<!ELEMENT note (#PCDATA)>
<!ELEMENT pending (date)>
<!ELEMENT date (#PCDATA)>

<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>
<!ELEMENT aux (tag, unit, timestamp, auxtype, valuelabel, value, data*)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT unit (#PCDATA)>
<!ELEMENT timestamp (#PCDATA)>
<!ELEMENT auxtype (#PCDATA)>
<!ELEMENT value (#PCDATA)>
<!ELEMENT valuelabel (#PCDATA)>
<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>
<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>

Important: As of Protocol version 1.06 the repair element has been moved from the top level of the inspinfo response to the defect element.

DTD (Version 2.X)

<!ELEMENT inspinfo (inspid, date, storetime, fleet, stat, mileage, operator, loadlocation, asset+)>
<!ATTLIST inspinfo ver CDATA #REQUIRED>
<!ELEMENT inspid (#PCDATA)>
<!ELEMENT date (#PCDATA)>
<!ELEMENT storetime (#PCDATA)>
<!ELEMENT fleet (#PCDATA)>
<!ELEMENT stat (#PCDATA)>
<!ELEMENT mileage (#PCDATA)>
<!ELEMENT operator (#PCDATA)>
<!ELEMENT loadlocation (#PCDATA)>
<!ELEMENT source (#PCDATA)>
<!ELEMENT sn (#PCDATA)>
<!ELEMENT firmware (#PCDATA)>
<!ATTLIST config ver CDATA #REQUIRED>
<!ELEMENT config (#PCDATA)>
<!ELEMENT sigstate (#PCDATA)>

<!ELEMENT asset (zone*, data*)>
<!ATTLIST asset id CDATA #REQUIRED>
<!ATTLIST asset fleet CDATA #REQUIRED>
<!ATTLIST asset primary CDATA #REQUIRED>
<!ATTLIST asset timestamp CDATA #REQUIRED>
<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>
<!ELEMENT zone (defect*, data*)>
<!ATTLIST zone name CDATA #REQUIRED>
<!ATTLIST zone timestamp CDATA #REQUIRED>
<!ATTLIST zone status (UN | ZOV | ZBV | ZONV | ZBNV) "UN">
<!ELEMENT defect (component, condition, ffd, defectid, repair*, pending*)>
<!ELEMENT component (#PCDATA)>
<!ELEMENT condition (#PCDATA)>
<!ELEMENT ffd (#PCDATA)>
<!ELEMENT defectid (#PCDATA)>
<!ELEMENT repair (agent, date, repid, orderno, note)>
<!ELEMENT agent (#PCDATA)>
<!ELEMENT date (#PCDATA)>
<!ELEMENT repid (#PCDATA)>
<!ELEMENT orderno (#PCDATA)>
<!ELEMENT note (#PCDATA)>
<!ELEMENT pending (date)>
<!ELEMENT date (#PCDATA)>

<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>
<!ELEMENT aux (tag, unit, timestamp, auxtype, valuelabel, value, data*)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT unit (#PCDATA)>
<!ELEMENT timestamp (#PCDATA)>
<!ELEMENT auxtype (#PCDATA)>
<!ELEMENT value (#PCDATA)>
<!ELEMENT valuelabel (#PCDATA)>
<!ELEMENT data EMPTY>
<!ATTLIST data name CDATA #REQUIRED>
<!ATTLIST data val CDATA #REQUIRED>
<!ATTLIST data type (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>

Reply Data
Name Description
inspid The internal id number of the inspection the asset was reported in.
date Unix epoch timestamp
storetime May be empty. Unix epoch timestamp.
fleet The primary asset fleet number. Usually displayed in the web interface as Asset No. Alphanumeric, 20 characters maximum.
stat Inspection status. Single ASCII character.

  • R Inspection is status Red. Either has critical defects or is incomplete.
  • Y Inspection is status Yellow. Has non critical defects and is complete.
  • G Inspection is status Green. Is complete and has no defects.
  • U Status is unknown. This should not occur.
mileage The numeric value reported for the primary asset. Usually, but not always the odometer reading at the time of the inspection. The specific inspection procedures will determine what this value means.
operator Name of the operator (driver) that performed the inspection. Last name, first name, 32 characters maximum.
loadlocation The upload location the inspection was sent from. Alphanumeric, 32 characters maximum, may be empty.
source The device that extracted the inspection from the Zonar 2010 hand held device.

  • RDS Reader Download Station. The device was a standard Zonar download station.
  • RADIO Device was an Evirnet radio.
  • MODEM Device was an Evircomm modem station.
  • EDITOR Manually generated inspection, created from a software application. Not currently implemented.
  • TEST Synthetic inspection created by testing software. Should not be seen in a production account.
  • UNK Unknown device. Should not be seen.
sn The serial number of the 2010 device used to perform the inspection.
firmware Name of the firmware used. Example: ZNR-4.1.0
config Inspection configuration name and version string. This is the actual name used internally in the system. For the label displayed in the web application see the cfglabel element. Example: TRUCK-2.0.1
sigstate Indicates the status of the return SSL certificate signature.

  • VAL Valid signature.
  • NOS No signature.
  • INV Invalid signature.
  • EDF Signature decode failed.
  • NOT Signature not checked.
  • EOK Failed to open public key (internal error, should not be seen).
  • ERK Failed to read public key (internal error, should not be seen).
  • EEK Failed to extractpublic key (internal error, should not be seen).
  • EVF Verify failed (internal error, should not be seen).
zone The name of the inspection zone the defect was reported in. Text, 20 characters maximum length.
component (defect) The defective component name. Text, 64 character maximum length.
condition (defect) The state of the defect. Text, 32 character maximum length.
ffd (defect) Fitness For Duty. If false, the defect prevents safe use of the asset. If true the asset may be safely used without repairing the defect.
defectid (defect) The defect internal id number.
agent (repair) The last and first name of the agent (mechanic) who performed the repair. Text, 66 characters maximum length (32 first name, 32 last name, 2 for comma and space).
date (repair) Timestamp the repair was performed. Unix epoch timestamp (UTC).
repid The internal id number for the repair (if any) performed on the defect.
orderno (repair) A user supplied string identifying the repair. May be a work order number or similar. The user’s specific operating practices will determine exactly what this means. Text, 20 characters maximum length, may be empty.
note (repair) A user supplied note describing the repair, or providing additional information. Text, unlimited length, will always have some content.
date (pending) Timestamp that this pending repair is to be repaired by. Unix epoch timestamp (UTC).
aux The auxiliary equipment that was inspected.
tag (aux) Zonar RFID tag number of the aux item. This combined with the auxtype uniquely identifies the item.
unit (aux) The unit number or name assigned to the object. Text, not longer than 32 characters. This value will be unique to the aux item.
timestamp (aux) Time the item was inspected. Unix epoch timestamp.
auxtype (aux) The type of object this item is. Text, not longer than 32 characters. This combined with the tag number uniquely identifies identifies the item.
valuelabel (aux) A label identifying the units the value refers to. Text, not longer than 32 characters.
value (aux) Numeric, may be zero.
Example Request

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

Example Success Reply (Version 1.07)

Example Request

http://development.zonarsystems.net/interface.php?action=showopen&operation=showinsp&target=4939&format=xml&version=2

Example Success Reply (Version 2.x)

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