5.13.4 SetMonitoringMode

5.13.4.1 Description

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.

5.13.4.2 Parameters

Table 69 defines the parameters for the Service.

Table 69 – SetMonitoringMode Service Parameters
NameTypeDescription
Request

requestHeader

RequestHeaderCommon request parameters (see 7.32 for RequestHeader definition).

subscriptionId

IntegerIdThe 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 []

IntegerIdList of Server-assigned ids for the MonitoredItems.
Response

responseHeader

Response HeaderCommon response parameters (see 7.33 for ResponseHeader definition).

results []

StatusCodeList of StatusCodes for the MonitoredItems to enable/disable (see 7.38 for StatusCode definition). The size and order of the list matches the size and order of the monitoredItemIds request parameter.

diagnosticInfos []

DiagnosticInfoList 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.
5.13.4.3 Service results

Table 70 defines the Service results specific to this Service. Common StatusCodes are defined in Table 178.

Table 70 – SetMonitoringMode Service Result Codes
Symbolic IdDescription
Bad_NothingToDoSee Table 178 for the description of this result code.
Bad_TooManyOperationsSee Table 178 for the description of this result code.
Bad_SubscriptionIdInvalidSee Table 178 for the description of this result code.
Bad_MonitoringModeInvalidSee Table 179 for the description of this result code.
5.13.4.4 StatusCodes

Table 71 defines values for the operation level results parameter that are specific to this Service. Common StatusCodes are defined in Table 179.

Table 71 – SetMonitoringMode Operation Level Result Codes
Symbolic IdDescription
Bad_MonitoredItemIdInvalidSee Table 179 for the description of this result code.