Routes

Request Data 

Returns a list of the routes configured in the system.

The following is a list of parameters that are required and optional for this request.

Required Information
Name	Description
action	adminroutes
operation	view
format	xml
Optional Information
target	Query for a specific route and only return information for that route. If specified a reqtype (request type) must be specified as well.
reqtype	Flag to identify the key being used to identify the route. Acceptable values: dbid Key is the internal database id number. This is the most reliable key to use. routenum Key is the route number.

Data Returned

DTD

<!ELEMENT routelist (route*)>
<!ATTLIST routelist ver CDATA #REQUIRED>
<!ATTLIST routelist count CDATA #REQUIRED>
<!ELEMENT route (name, start, end, duration, asset*, operator*)>
<!ATTLIST route id CDATA #REQUIRED> <!ELEMENT routenum (#PCDATA)>
<!ELEMENT start (#PCDATA)>
<!ELEMENT end (#PCDATA)>
<!ELEMENT duration (#PCDATA)>
<!ELEMENT asset (fleet, tagid, type)>
<!ATTLIST asset id CDATA #REQUIRED>
<!ELEMENT fleet (#PCDATA)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT type (#PCDATA)>
<!ELEMENT operator (fname, lname, tag)>
<!ATTLIST operator id CDATA #REQUIRED>
<!ELEMENT fname (#PCDATA)>
<!ELEMENT lname (#PCDATA)>
<!ELEMENT tag (#PCDATA)>

Reply Data
Name	Description
ver	The version number of the API call and return data.
count	The number of results returned.
id	The internal database identifier number for the route. Unsigned integer quantity.
routenum	The route number label for the route. String data 32 characters maximum length.
start	The starting time of the route. Expressed in HH:MM:SS TZ 24 hour time.
end	The ending time of the route. Expressed in HH:MM:SS TZ 24 hour time.
duration	The time required for the route. Expressed in HH:MM:SS format.
asset	The asset (if any) assigned this route.
id	The assigned asset's internal database identifier.
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.
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.
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.
operator	The driver (if any) assigned to this route.
id	The assigned operators's internal database identifier.
fname	Operator's first name. An arbitrary text string of up to 32 characters in length.
lname	Operator's last name. An arbitrary text string of up to 32 characters in length.
tag	Zonar Systems™ RFID tag number of the operator. A non zero 32 bit integer quantity.

Example Request

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=adminroutes&operation=view&format=xml

Example Success Reply

<routelist ver="1">
<count>2</count>
<route id="2">
<routenum>Route 27</routenum>
<start>08:00:00-08</start>
<end>13:15:00-08</end>
<duration>05:15:00</duration>
<asset id="59">
<fleet>FLT123456</fleet>
<tag>765789</tag>
<type id="0">Standard</type>
</asset>
<operator id="24">
<fname>Joe</fname>
<lname>Smith</lname>
<tag>98745</tag>
</operator>
</route>
<route id="3">
<routenum>Route 9</routenum>
<start>07:35:00-08</start>
<end>10:00:00-08</end>
<duration>02:25:00</duration>
</route>
</routelist>