Status Operational Status

Expired Operators Report

  • Last edited on

 Returns a report of operator expiry information.

This action was added to protocol version 1.01.

Request Data 

Required Information
Name Description
action showexpire
operation operator
format xml
rpttype The type of report to create. Acceptable values:
  • date Return operators that will expire within the specified threshold. If no threshold is specified, a threshold of 0 will be assumed.
  • operator Create an expiry report for the specified operator. A target operator must be specified.
Optional Information
location Location to filter with. Text. If provided only operators assigned to that location will be returned. returned. If location is not supplied or an empty location is specified, assets from all locations will be returned.
threshold Threshold to include expiry information in the report. A number of days. Expirations that will occur within the specified number of days are included. If not specified a threshold of 0 will be used.

threshold is not used if rpttype=operator
target The operator to create the report for. If report type is specified as operator this must be supplied.

target is not used if rpttype=date
reqtype Flag to identify the key being used to identify the target operator. Acceptable values:
  • dbid Key is the internal database id number. The most reliable key to use.
  • cdl Key is the operator's CDL (Commercial Driver's License number).
  • empnum Key is the operator's employee number.
  • tag Key is the operator's Zonar RFID tag number.

reqtype is not used if rpttype=date
expdatetype May be specified for any report type. Only return expiry dates of the specified type. Must be a valid expiry type.

Data Returned

A list of operators with expiry dates.

DTD

<!ELEMENT opexpirelist (opexpire*)>
<!ATTLIST opexpirelist ver CDATA #REQUIRED>
<!ELEMENT opexpire (fname, lname, cdl, empnum, status, location, dateexpire)>
<!ATTLIST opexpire dbid CDATA #REQUIRED>
<!ELEMENT fname (#PCDATA)>
<!ELEMENT lname (#PCDATA)>
<!ELEMENT cdl (#PCDATA)>
<!ELEMENT empnum (#PCDATA)>
<!ELEMENT location (#PCDATA)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT dateexpire (label, expdate, remainingdays)>
<!ELEMENT label (#PCDATA)>
<!ELEMENT expdate (#PCDATA)>
<!ELEMENT remainingdays (#PCDATA)>

The dbid attribute is the database id number of the operator. The remainingdays is the number of days remaining until the expiration occurs. This may be zero or a negative number in which case the expiration has already occurred. In protocol version 1.07 the tag element was added to provide the operator's Zonar RFID tag number.

Example Request

Return a list of all operator expirations that will occur within 10 days.

https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=showexpire&operation=operator&format=xml&rpttype=date&threshold=10

Example Success Reply

<?xml version="1.0"?>
<opexpirelist ver="1.07">
 <opexpire dbid="18">
 <fname>Driver</fname>
 <lname>One</lname>
 <cdl>PC37629HA</cdl>
 <empnum>12200</empnum>
 <location>Home</location>
 <tag>3635</tag>
 <dateexpire>
 <label>Medical Card</label>
 <expdate>2005-03-15</expdate>
 <remainingdays>-59</remainingdays>
 </dateexpire>
 </opexpire>
 <opexpire dbid="17">
 <fname>Driver</fname>
 <lname>Two</lname>
 <cdl>WA879M4367</cdl>
 <empnum>25845</empnum>
 <location>Home</location>
 <tag>25845</tag>
 <dateexpire>
 <label>Forklift Certification</label>
 <expdate>2005-05-21</expdate>
 <remainingdays>7</remainingdays>
 </dateexpire>
 </opexpire>
 <opexpire dbid="17">
 <fname>Driver</fname>
 <lname>Two</lname>
 <cdl>WA879M4367</cdl>
 <empnum>25845</empnum>
 <location>Home</location>
 <tag>25845</tag>
 <dateexpire>
 <label>DOT Physical</label>
 <expdate>2005-05-21</expdate>
 <remainingdays>7</remainingdays>
 </dateexpire>
 </opexpire>
</opexpirelist>

 

Driver Management