28. Inspection Data

Use this to retrieve a list of the inspection data values from inspections within specified parameters.

28.1 Request Data

Required Information
Name	Description
action	showopen
operation	inspdata
format	xml
Optional Information
logvers	The supported versions are: `1` - Default output. `2` - Adds an additional attribute, insp_zone_name, to the idata element. Note: If no value is passed, `1` is assumed.
location	Location to filter with. Text. If provided only inspections with an asset and or an operator assigned to that location will be returned. If location is not supplied or an empty location is specified, data from inspections from all locations will be returned.
start	Epoch timestamp. Results will be from inspections that occurred during or after this time. May be combined with `end` to specify a particular time period.
end	Epoch timestamp. Results will be from inspections that occurred during or before this time. May be combined with `start` to specify a particular time period.
tstype	A flag to indicate what the timestamp variable represents. Acceptable values are: `insp` Timestamp is the inspection time. Inspections that were performed after this time will be returned. `load` Timestamp is the time the inspection was added to the Zonar-Web system. Inspections that were uploaded after this time will be returned. If tstype is not specified, or is blank a value of '`insp`' will be assumed.

Required Information

Name

Description

action

showopen

operation

inspdata

format

xml

Optional Information

logvers

The supported versions are:

1 - Default output.
2 - Adds an additional attribute, insp_zone_name, to the idata element.

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

location

Location to filter with. Text. If provided only inspections with an asset and or an operator assigned to that location will be returned. If location is not supplied or an empty location is specified, data from inspections from all locations will be returned.

start

Epoch timestamp. Results will be from inspections that occurred during or after this time. May be combined with end to specify a particular time period.

end

Epoch timestamp. Results will be from inspections that occurred during or before this time. May be combined with start to specify a particular time period.

tstype

A flag to indicate what the timestamp variable represents. Acceptable values are:

insp Timestamp is the inspection time. Inspections that were performed after this time will be returned.
load Timestamp is the time the inspection was added to the Zonar-Web system. Inspections that were uploaded after this time will be returned.

If tstype is not specified, or is blank a value of 'insp' will be assumed.

28.2 Data Returned

DTD for logvers=1:


 <!ELEMENT inspdata (count, idata*)>

 <!ATTLIST inspdata  ver       	CDATA #REQUIRED>

 <!ATTLIST inspdata  count  CDATA #REQUIRED>

 <!ATTLIST inspdata  start  CDATA #REQUIRED>

 <!ATTLIST inspdata  end  CDATA #REQUIRED>


 <!ELEMENT idata  (#PCDATA)>

 <!ATTLIST idata  id           CDATA #REQUIRED>

 <!ATTLIST idata  timestamp           CDATA #REQUIRED>

 <!ATTLIST idata  stat                CDATA #REQUIRED>

 <!ATTLIST idata  fleet               CDATA #REQUIRED>

 <!ATTLIST idata  asset_exsid         CDATA #REQUIRED>

 <!ATTLIST idata  operator            CDATA #REQUIRED>
 
 <!ATTLIST idata  optag               CDATA #REQUIRED>

 <!ATTLIST idata  operator_exsid      CDATA #REQUIRED>

 <!ATTLIST idata  loadlocation        CDATA #REQUIRED>

 <!ATTLIST idata  extractor           CDATA #REQUIRED>

 <!ATTLIST idata  assetid             CDATA #REQUIRED>

 <!ATTLIST idata  opid                CDATA #REQUIRED>

 <!ATTLIST idata  assetvalue          CDATA #REQUIRED>

 <!ATTLIST idata  cfglabel            CDATA #REQUIRED>

 <!ATTLIST idata  loadtime            CDATA #REQUIRED>

 <!ATTLIST idata  sn                  CDATA #REQUIRED>

 <!ATTLIST idata  name                  CDATA #REQUIRED>

 <!ATTLIST idata  type        	(INT | FLOAT | STRING | UNKNOWN) #REQUIRED>

DTD for logvers=2:


 <!ELEMENT inspdata (count, idata*)>

 <!ATTLIST inspdata  ver         CDATA #REQUIRED>

 <!ATTLIST inspdata  count  CDATA #REQUIRED>

 <!ATTLIST inspdata  start  CDATA #REQUIRED>

 <!ATTLIST inspdata  end  CDATA #REQUIRED>


 <!ELEMENT idata  (#PCDATA)>

 <!ATTLIST idata  id           CDATA #REQUIRED>

 <!ATTLIST idata  timestamp           CDATA #REQUIRED>

 <!ATTLIST idata  stat                CDATA #REQUIRED>

 <!ATTLIST idata  fleet               CDATA #REQUIRED>

 <!ATTLIST idata  asset_exsid         CDATA #REQUIRED>

 <!ATTLIST idata  operator            CDATA #REQUIRED>
 
 <!ATTLIST idata  optag               CDATA #REQUIRED>

 <!ATTLIST idata  operator_exsid      CDATA #REQUIRED>

 <!ATTLIST idata  loadlocation        CDATA #REQUIRED>

 <!ATTLIST idata  extractor           CDATA #REQUIRED>

 <!ATTLIST idata  assetid             CDATA #REQUIRED>

 <!ATTLIST idata  opid                CDATA #REQUIRED>

 <!ATTLIST idata  assetvalue          CDATA #REQUIRED>

 <!ATTLIST idata  cfglabel            CDATA #REQUIRED>

 <!ATTLIST idata  loadtime            CDATA #REQUIRED>

 <!ATTLIST idata  sn                  CDATA #REQUIRED>

 <!ATTLIST idata  name                  CDATA #REQUIRED>

 <!ATTLIST idata  type           (INT | FLOAT | STRING | UNKNOWN) #REQUIRED>

 <!ATTLIST idata insp_zone_name       CDATA #REQUIRED>

Reply Data
Name	Description
version	The version number of the OMI call and return data.
count	The number of results returned.
start	The request epoch start time.
end	The request epoch end time .
id	Inspection id number. Use as a target for the get inspection details function.
timestamp	The timestamp of the inspection. Specifically the timestamp of the primary asset tag read. Unix epoch timestamp (UTC).
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.
fleet	The primary asset fleet number in the inspection. Usually displayed in the web interface as Asset No. Alphanumeric, 20 characters maximum.
operator	Name of the operator (driver) that performed the inspection. First name, last name, 32 characters each maximum.
optag	Tagid for the operator (driver) that performed the inspection. Numeric.
loadlocation	The upload location the inspection was sent from. Alphanumeric, 32 characters maximum, may be empty.
extractor	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. `GPS` Device was a GPS units GSM modem. `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.
assetid	Primary asset id.
opid	Operator (driver) id.
assetvalue	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.
cfglabel	Inspection configuration label.
loadtime	When the inspection was loaded into the database. Unix epoch timestamp (UTC).
sn	The serial number of the 2010 device used to perform the inspection.
name	Label used to identify the data value. String, 32 characters maximum length.
type	The type of data. `INT` Data is an integer value. `FLOAT` Data is a double precision floating point value. `STRING` Data is a string, maximum length 255 characters. `UNKNOWN` Should not be encountered.
insp_zone_name	The name of the LOI* where the inspection was performed.
-	The inspection data itself

Reply Data

Name

Description

version

The version number of the OMI call and return data.

count

The number of results returned.

start

The request epoch start time.

end

The request epoch end time .

Inspection id number. Use as a target for the get inspection details function.

timestamp

The timestamp of the inspection. Specifically the timestamp of the primary asset tag read. Unix epoch timestamp (UTC).

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.

fleet

The primary asset fleet number in the inspection. Usually displayed in the web interface as Asset No. Alphanumeric, 20 characters maximum.

operator

Name of the operator (driver) that performed the inspection. First name, last name, 32 characters each maximum.

optag

Tagid for the operator (driver) that performed the inspection. Numeric.

loadlocation

The upload location the inspection was sent from. Alphanumeric, 32 characters maximum, may be empty.

extractor

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.
GPS Device was a GPS units GSM modem.
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.

assetid

Primary asset id.

opid

Operator (driver) id.

assetvalue

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.

cfglabel

Inspection configuration label.

loadtime

When the inspection was loaded into the database. Unix epoch timestamp (UTC).

The serial number of the 2010 device used to perform the inspection.

name

Label used to identify the data value. String, 32 characters maximum length.

type

The type of data.

INT Data is an integer value.
FLOAT Data is a double precision floating point value.
STRING Data is a string, maximum length 255 characters.
UNKNOWN Should not be encountered.

insp_zone_name

The name of the LOI* where the inspection was performed.

The inspection data itself

Example Request Get inspection data for all inspection within a period of time:


 https://development.zonarsystems.net/interface.php?action=showopen&operation=inspdata&format=xml&customer=abc1234&start=1141397988&end=1141398000&vers=2