Technical information

RMS NetLinx Virtual Device API
158
RMS Enterprise - NetLinx Programmer’s Guide
RMS Hotlist Query Commands (Cont.)
Query Command Description / Response Command
?HOTLIST.RECORD.TYPE-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested
hotlist record type (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.TYPE-<location-id>,
<record-index>,
<record-count>,
<hotlist-type-id>,
<hotlist-type-name>
The hotlist types available are listed below:
0 - CLIENT_GATEWAY
1 - PARAMETER_TRIP
2 - SERVICE_PROVIDER
3 - ASSET_MAINTENANCE
4 - LOCATION_MAINTENANCE
5 - USER
6 - NOTIFICATION_PROVIDER
7 - LOG_PROVIDER
8 - SCHEDULING
9 - MESSAGE
?HOTLIST.RECORD.STATUS.TYPE-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record status type (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.STATUS.TYPE-<location-id>,
<record-index>,
<record-count>,
<status-type-id>,
<status-type-name>
There are system defined status types as well as user defined status types. The available
status types can be viewed/configured in the RMS web settings pages.
?HOTLIST.RECORD.PRIORITY-
<start>(,<length>)(,<location-id>)
This command will query the RMS client hotlist record cache and return the requested hot-
list record priority level(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.PRIORITY-<location-id>,
<record-index>,
<record-count>,
<priority-level>