Technical information

RMS NetLinx Virtual Device API
159
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist Query Commands (Cont.)
Query Command Description / Response Command
?HOTLIST.RECORD.DESCRIPTION-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record description(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.DESCRIPTION-<location-id>,
<record-index>,
<record-count>,
<description>
?HOTLIST.RECORD.TIMESTAMP-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record relative date and time(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.TIMESTAMP-<location-id>,
<record-index>,
<record-count>,
<relative-date-string>,
<relative-time-string>
The relative date and time strings are formatted for the locale of the default location that the
client gateway is assigned to. These string are intended for display on the user interface, if
you need a programmatic date/time string with a fixed format, please see the HOT-
LIST.RECORD.CREATED and HOTLIST.RECORD.MODIFIED commands.
?HOTLIST.RECORD.ASSET-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record asset id and name(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.ASSET-<location-id>,
<record-index>,
<record-count>,
<asset-id>,
<asset-name>
Please note that the asset id may be 0 and the asset name may be empty if no asset is
associated with a given hotlist record.