This Service is invoked to delete one or more Subscriptions that belong to the Client's Session.
Successful completion of this Service causes all MonitoredItems that use the Subscription to be deleted. If this is the last Subscription for the Session, then all Publish requests still queued for that Session are de-queued and shall be returned with Bad_NoSubscription.
Subscriptions that were transferred to another Session shall be deleted by the Client that owns the Session.
Table 103 defines the parameters for the Service.
Table 103 – DeleteSubscriptions Service Parameters
|
Name |
Type |
Description |
|
Request |
|
|
|
requestHeader |
RequestHeader |
Common request parameters (see 7.33 for RequestHeader definition). |
|
subscriptionIds [] |
IntegerId |
The Server-assigned identifier for the Subscription (see 7.19 for IntegerId definition). |
|
|
|
|
|
Response |
|
|
|
responseHeader |
ResponseHeader |
Common response parameters (see 7.34 for ResponseHeader definition). |
|
results [] |
StatusCode |
List of StatusCodes for the Subscriptions to delete (see 7.39 for StatusCode definition). The size and order of the list matches the size and order of the subscriptionIds request parameter. |
|
diagnosticInfos [] |
DiagnosticInfo |
List of diagnostic information for the Subscriptions to delete (see 7.12 for DiagnosticInfo definition). The size and order of the list matches the size and order of the subscriptionIds 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 104 defines the Service results specific to this Service. Common StatusCodes are defined in Table 182.
Table 104 – DeleteSubscriptions 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. |
Table 105 defines values for the results parameter that are specific to this Service. Common StatusCodes are defined in Table 183.
Table 105 – DeleteSubscriptions Operation Level Result Codes
|
Symbolic Id |
Description |
|
Bad_SubscriptionIdInvalid |
See Table 182 for the description of this result code. |