Returns packet messages from GPS units.
Request Data
| Required Information |
| Name |
Description |
| action |
showopen |
| operation |
getphonehome |
| format |
xml |
| startdate |
date for report start limit - must be in epoch format |
| enddate |
date for report end limit - must be in epoch format(total time must be less than 24 hours) |
| Optional Information |
| Name |
Description |
| target |
Specific asset to report for, rather than entire fleet. If specified then reqtype and type must be specified as well. |
| reqtype |
Flag to identify the key being used to query. Acceptable values:
- tag Key is a Zonar RFID tag number. In version 2 a type must also be specified.
- exsid Key is the external system id.
- vin Key is the Vehicle Identification Number (VIN).
- dbid Key is the internal id number. This is the most reliable key to use.
- fleet Key is the asset fleet number. In version 2 a type must also be specified.
|
| type |
When using reqtype of tag or fleet this must also be specified. Type Standard (0) is assumed. See asset types for more details. |
Data Returned
DTD
<!ELEMENT gpsphonelist (gpsphonecall*) >
<!ATTLIST gpsphonelist ver CDATA #REQUIRED>
<!ELEMENT gpsphonecall (asset, scid, fwver, uploc, logvers, gpssn, timestamp) >
<!ELEMENT asset >
<!ATTLIST asset tagid CDATA #REQUIRED>
<!ATTLIST asset fleet CDATA #REQUIRED>
<!ATTLIST asset id CDATA #REQUIRED>
<!ATTLIST asset exsid CDATA #REQUIRED>
<!ATTLIST asset type CDATA #REQUIRED>
<!ELEMENT scid (#PCDATA)>
<!ELEMENT fwver (#PCDATA)>
<!ELEMENT uploc (#PCDATA)>
<!ELEMENT logvers (#PCDATA)>
<!ELEMENT gpssn (#PCDATA)>
<!ELEMENT timestamp (#PCDATA)>
| Reply Data |
| Name |
Description |
| tagid |
The Zonar RFID tag number assigned to the asset. |
| fleet |
Fleet number. An arbitrary text string of up to 20 characters in length. |
| id |
ID. The internal database identification number. |
| exsid |
EXSID. The external system identification number. |
| type |
The asset type identifier. |
| scid |
SCID of the unit sending data |
| fwver |
Firmware version of GPS unit sending data |
| uploc |
Upload location name of where the data was sent |
| logvers |
Logvers of the unit sending data |
| gpssn |
GPS Serial Number of GPS unit sending data |
| timestamp |
Datetime stamp of when the data was sent |
Example Request
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showopen&operation=getphonehome&startdate=1237100400&enddate=1237186800&format=xml
Example Success Reply
<?xml version="1.0"?>
<gpsphonelist ver="1.0">
<gpsphonecall>
<asset tagid="" fleet="AT_24858_RevD-Epoxy" id="411" exsid="" type="0"/>
<scid>89310380106035626078</scid>
<fwver>EGPS-0.0.83 03/10/2009</fwver>
<uploc/>
<logvers>1001</logvers>
<gpssn>24858</gpssn>
<timestamp>1237446047.31203</timestamp>
</gpsphonecall>
</gpsphonelist>
