Expired Aux Items Report

Request Data

 Use this request to create reports of expiry information for the aux items in the system.

Note: This action was added to protocol version 1.01.

Required Information
Name	Description
action	showexpire
operation	aux
format	xml
rpttype	The type of report to create. Acceptable values: date Return aux items with time based expirys that will expire within the specified day threshold. If no threshold is specified, a threshold of 0 will be assumed. value Return aux items with value based expirys that will expire within the specified value threshold. If no threshold is specified, a threshold of 0 will be assumed. auxdate Return a list of time based expirys for the specified aux item. A target aux item must be specified. Threshold is ignored. auxvalue Return a list of value based expirys for the specified aux item. A target ux item must be specified. Threshold is ignored.
Optional Information
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. Must be a valid location name.
threshold	If a date or value rpttype is specified this may be provided. Integer, represents either the remaining days for a date based expire or the remaining value units for value based expires.
target	Must be supplied if a rpttype of auxdate or auxvalue is specified. Represents the specific aux item to report on.
reqtype	Indicates what the type of target is specified. Currently the only supported value is dbid.

Data Returned

Returned information:

A list of aux items with expiry information.

DTD:

<!ELEMENT auxexpirelist (auxexpire*)>
<!ATTLIST auxexpirelist ver CDATA #REQUIRED>
<!ELEMENT auxexpire (tag,unit ,auxtype ,location, expire)>
<!ATTLIST auxexpire dbid CDATA #REQUIRED>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT unit (#PCDATA)>
<!ELEMENT auxtype (#PCDATA)>
<!ELEMENT location (#PCDATA)>
<!ELEMENT expire (label, exp, remaining, +currval)>
<!ATTLIST expire exptype (date|value) #REQUIRED>
<!ELEMENT label (#PCDATA)>
<!ELEMENT exp (#PCDATA)>
<!ELEMENT remaining (#PCDATA)>
<!ELEMENT currval (#PCDATA)>

Example Request

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

Example Success Reply