5.14.8 DeleteSubscriptions

5.14.8.1 Description

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.

5.14.8.2 Parameters

Table 97 defines the parameters for the Service.

Table 97 – DeleteSubscriptions Service Parameters
NameTypeDescription
Request

requestHeader

RequestHeaderCommon request parameters (see 7.32 for RequestHeader definition).

subscriptionIds []

IntegerIdThe Server-assigned identifier for the Subscription (see 7.19 for IntegerId definition).
Response

responseHeader

ResponseHeaderCommon response parameters (see 7.33 for ResponseHeader definition).

results []

StatusCodeList of StatusCodes for the Subscriptions to delete (see 7.38 for StatusCode definition). The size and order of the list matches the size and order of the subscriptionIds request parameter.

diagnosticInfos []

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

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

Table 98 – DeleteSubscriptions 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.
5.14.8.4 StatusCodes

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

Table 99 – DeleteSubscriptions Operation Level Result Codes
Symbolic IdDescription
Bad_SubscriptionIdInvalidSee Table 178 for the description of this result code.