This Service is used to set the monitoring mode for one or more MonitoredItems of a Subscription. Setting the mode to DISABLED causes all queued Notifications to be deleted.
Table 75 defines the parameters for the Service.
Table 75 – SetMonitoringMode Service Parameters
|
Name |
Type |
Description |
|
Request |
|
|
|
requestHeader |
RequestHeader |
Common request parameters (see 7.33 for RequestHeader definition). |
|
subscriptionId |
IntegerId |
The Server-assigned identifier for the Subscription used to qualify the monitoredItemIds (see 7.19 for IntegerId definition). |
|
monitoringMode |
Enum MonitoringMode |
The monitoring mode to be set for the MonitoredItems. The MonitoringMode enumeration is defined in 7.23. |
|
monitoredItemIds [] |
IntegerId |
List of Server-assigned ids for the MonitoredItems. |
|
|
|
|
|
Response |
|
|
|
responseHeader |
Response Header |
Common response parameters (see 7.34 for ResponseHeader definition). |
|
results [] |
StatusCode |
List of StatusCodes for the MonitoredItems to enable/disable (see 7.39 for StatusCode definition). The size and order of the list matches the size and order of the monitoredItemIds request parameter. |
|
diagnosticInfos [] |
DiagnosticInfo |
List of diagnostic information for the MonitoredItems to enable/disable (see 7.12 for DiagnosticInfo definition). The size and order of the list matches the size and order of the monitoredItemIds request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request. |
Table 76 defines the Service results specific to this Service. Common StatusCodes are defined in Table 182.
Table 76 – SetMonitoringMode Service Result Codes
|
Symbolic Id |
Description |
|
Bad_NothingToDo |
See Table 182 for the description of this result code. |
|
Bad_TooManyOperations |
See Table 182 for the description of this result code. |
|
Bad_SubscriptionIdInvalid |
See Table 182 for the description of this result code. |
|
Bad_MonitoringModeInvalid |
See Table 183 for the description of this result code. |
Table 77 defines values for the operation level results parameter that are specific to this Service. Common StatusCodes are defined in Table 183.
Table 77 – SetMonitoringMode Operation Level Result Codes
|
Symbolic Id |
Description |
|
Bad_MonitoredItemIdInvalid |
See Table 183 for the description of this result code. |