Technical information
RMS NetLinx Virtual Device API
157
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist Query Commands (Cont.)
Query Command Description / Response Command
?HOTLIST.RECORD.CREATED-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record created date(s).
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
The hotlist record(s) will be returned in the following command response format:
HOTLIST.RECORD.CREATED-<location-id>,
<record-index>,
<record-count>,
<created-date>
The date string will be provided in the international ISO-8601 standard format:
YYYY-MM-DDThh:mm:ss
http://www.iso.org/iso/date_and_time_format
?HOTLIST.RECORD.MODIFIED-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested
hotlist record last modified date(s).
The <start> argument can be either a '*' character or a number representing which index
position to start at. If the '*' character is assigned to the start parameter the query will return
all hotlist records. The collection is '1' based and should start at index 1 (not '0').
The <length> argument is optional and can be a number representing how many records to
return. If this argument is not specified, then a length of 1 is assumed.
The <location-id> argument is optional. If included the hotlist query will perform a lookup on
the specified location. If omitted, the hotlist query will perform a lookup on the client gate-
way's default location.
The hotlist record(s) will be returned in the following command response format:
HOTLIST.RECORD.MODIFIED-<location-id>,
<record-index>,
<record-count>,
<modified-date>
The date string will be provided in the international ISO-8601 standard format:
YYYY-MM-DDThh:mm:ss
http://www.iso.org/iso/date_and_time_format