Request Data
In version 1.X this function returns complete information for a specified aux object. Version 2.X allows a complete list of all aux objects in the system to be returned, with location and type filtering.
Aux items represent some kind of minor (auxiliary) equipment to be inspected. Each aux item is uniquely identified by a type label and an RFID tag number combination. When inspected, an aux item may have an optional numeric value associated with it. This value is explained by the valuelabel defined by the aux type. For example aux items of type 'DOLLY' might have a valuelabel of miles, with the value representing the odometer reading at the time of inspection.
| Version 2.X Required Information | |
|---|---|
| Name | Description |
| action | showopen |
| operation | aux |
| format | xml |
| Optional Information | |
| auxtype | The type label of the requested item(s). DOLLY, TRAILER, etc. Must be an existing aux item type. Only aux items with this type will be returned. This may be combined with the 'target' to specify a specific object, or used on it's own to produce a list of aux objects of the specified type. |
| target | Zonar RFID Tag number of the requested item(s). Only items with the specified tag number will be returned. This may be combined with the 'auxtype' to specify a specific object, or used on it's own to produce a list of aux objects with the specified tag number. |
| location | Location to filter with. Text. If provided only aux items assigned to that location will be returned. If location is not supplied or an empty location is specified, aux items from all locations will be returned. |
| logvers | Possible values:
|
Note: If no value is passed, 1 is assumed.
| Version 1.X Required Information | |
|---|---|
| Name | Description |
| action | extgetaux (Deprecated New clients should use 'showopen' with operation 'aux') |
| operation | aux (Required if using the 'showopen' action.) |
| format | xml (Required if using the 'showopen' action.) |
| auxtype | The type label of the requested item. DOLLY, TRAILER, etc. |
| target | Zonar RFID Tag number of the requested item. |
Returned information, Version 2.X
A list of aux items
DTD
<!ELEMENT auxlist (aux*)>
<!ATTLIST auxlist ver CDATA #REQUIRED>
<!ELEMENT aux (tag, unit, auxtype, valuelabel, value, location)>
<!ATTLIST aux id CDATA #REQUIRED>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT unit (#PCDATA)>
<!ELEMENT auxtype (#PCDATA)>
<!ELEMENT valuelabel (#PCDATA)>
<!ELEMENT value (#PCDATA)>
<!ELEMENT location (#PCDATA)>
<!ELEMENT timestamp (#PCDATA)>
Returned information, Version 1.X
An aux item message
DTD
<!ELEMENT aux (tag, unit, auxtype, valuelabel, value, location)>
<!ATTLIST aux ver CDATA #REQUIRED>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT unit (#PCDATA)>
<!ELEMENT auxtype (#PCDATA)>
<!ELEMENT valuelabel (#PCDATA)>
<!ELEMENT value (#PCDATA)>
<!ELEMENT location (#PCDATA)>
| Reply Data | |
|---|---|
| Name | Description |
| tag | Zonar Systems™ RFID tag number of the aux item. This combined with the auxtype uniquely identifies the item. |
| id | Version 2.X only. The internal database identifier for the aux item. Numeric, always non zero. |
| unit | The unit number or name assigned to the object. Text, not longer than 32 characters. This value will be unique to the aux item. |
| auxtype | 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 | A label identifying the units the value refers to. Text, not longer than 32 characters. The valuelabel is a property of the aux type. |
| value | The last reported value for this aux item. Numeric, may be zero. |
| location | The location that the aux item is assigned to. Text, not longer than 32 characters. |
| Timestamp | Timestamp if available. , Unix epoch timestamp (UTC). |
Example Request (Version 2.X)
Return a list of all aux items.
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showopen&operation=aux&format=xml&version=2
Return a list of all aux items of type 'REFER' https://development.zonarsystems.net/interface.php?action=showopen&operation=aux&format=xml&version=2&auxtype=REFER
Example Request (Version 1.X Preferred form)
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showopen&operation=aux&format=xml&auxtype=REFER&target=2300
Example Request (Version 1.X Deprecated form)
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=extgetaux&auxtype=REFER&target=2300