This operation is intended to stop a subscription process in the ASM Support System in response to a request from an External User. As a result, a subscription process is either stopped in the local ASM Support System and the External User stops receiving subscribed data, or a subscription is not stopped and an appropriate error message is transmitted to the External User. Once the subscription has stopped HeartbeatTechnicalMessages can be stopped by the ASM Support System.
Associated messages
ASM-INTF-SUBS-170: The stopSubscription operation shall receive and process the SubscriptionStopRequest message from an External User.
ASM-INTF-SUBS-180: The stopSubscription operation shall validate the SubscriptionStopRequest message against the following criteria which must be met:
o All mandatory data for SubscriptionStopRequest message are provided,
o The identified subscription to be stopped must belong to the requestor,
o The identified subscription to be stopped must be ‘ACTIVE'.
ASM-INTF-SUBS-190: If the request is valid, the stopSubscription operation shall return the SubscriptionStopReply message to the requesting External User.
ASM-INTF-SUBS-200: The SubscriptionStopReply message shall contain the details of the subscription, including the name of the queue to be used and the state which will be ‘PAUSED’.
ASM-INTF-SUBS-210: If the request is not valid, the stopSubscription operation shall transmit an appropriate error in the SubscriptionStopReply message to the requesting External User.
ASM-INTF-SUBS-215: The stopSubscription operation may optionally stop the HeartbeatTechnicalMessages while the subscription is in the state PAUSED by adding the attribute heartbeatEnabled with the value false to the StopSubscriptionRequest.
ASM-INTF-SUBS-217: The server should publish a SubscriptionTechnicalMessage to the subscription queue when the server itself has PAUSED the subscription, independent of the external user requesting to PAUSE the subscription via the stopSubscription operation.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.