5 Service Sets ToC Previous Next

5.12 MonitoredItem Service Set ToC Previous Next

5.12.4 SetMonitoringMode ToC Previous Next

5.12.4.1 Description ToC

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.12.4.2 Parameters ToC

Table 75 defines the parameters for the Service.

Table 75 – SetMonitoringMode Service Parameters

Name Type Description
Request    
   requestHeader RequestHeader Common request parameters (see 7.28 for RequestHeader definition).
   subscriptionId IntegerId The Server-assigned identifier for the Subscription used to qualify the monitoredItemIds (see 7.14 for IntegerId definition).
   monitoringMode Enum
MonitoringMode
The monitoring mode to be set for the MonitoredItems. The MonitoringMode enumeration is defined in 7.18.
   monitoredItemIds [] IntegerId List of Server-assigned ids for the MonitoredItems.
     
Response    
   responseHeader Response Header Common response parameters (see 7.29 for ResponseHeader definition).
   results [] StatusCode List of StatusCodes for the MonitoredItems to enable/disable (see 7.34 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.8 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.12.4.3 Service results ToC

Table 76 defines the Service results specific to this Service. Common StatusCodes are defined in Table 177.

Table 76 – SetMonitoringMode Service Result Codes

Symbolic Id Description
Bad_NothingToDo See Table 177 for the description of this result code.
Bad_TooManyOperations See Table 177 for the description of this result code.
Bad_SubscriptionIdInvalid See Table 177 for the description of this result code.
Bad_MonitoringModeInvalid See Table 178 for the description of this result code.

5.12.4.4 StatusCodes ToC

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

Table 77 – SetMonitoringMode Operation Level Result Codes

Symbolic Id Description
Bad_MonitoredItemIdInvalid See Table 178 for the description of this result code.

Previous Next