5.14.5.2 Parameters
Table 89 defines the parameters for the Service.
| Name | Type | Description |
|---|---|---|
| Request | ||
requestHeader | RequestHeader | Common request parameters (see 7.32 for RequestHeader definition). |
subscription Acknowledgements [] | Subscription Acknowledgement | The list of acknowledgements for one or more Subscriptions. This list may contain multiple acknowledgements for the same Subscription (multiple entries with the same subscriptionId). This structure is defined in-line with the following indented items. |
subscriptionId | IntegerId | The Server assigned identifier for a Subscription (see 7.19 for IntegerId definition). |
sequenceNumber | Counter | The sequence number being acknowledged (see 7.8 for Counter definition). The Server may delete the Message with this sequence number from its retransmission queue. |
| Response | ||
|---|---|---|
responseHeader | ResponseHeader | Common response parameters (see 7.33 for ResponseHeader definition). |
subscriptionId | IntegerId | The Server-assigned identifier for the Subscription for which Notifications are being returned (see 7.19 for IntegerId definition). The value 0 is used to indicate that there were no Subscriptions defined for which a response could be sent. |
availableSequence Numbers [] | Counter | A list of sequence number ranges that identify unacknowledged NotificationMessages that are available for retransmission from the Subscription’s retransmission queue including the sequence number of this response if it is not a keep-alive Message. This list is prepared after processing the acknowledgements in the request (see 7.8 for Counter definition). The list shall be empty if the Server does not support the retransmission queue. If the list is empty, the Client should not acknowledge sequence numbers. This information is for diagnostic purpose and Clients should log differences to the expected sequence numbers. |
moreNotifications | Boolean | A Boolean parameter with the following values: TRUE the number of Notifications that were ready to be sent could not be sent in a single response. FALSE all Notifications that were ready are included in the response. |
notificationMessage | Notification Message | The NotificationMessage that contains the list of Notifications. The NotificationMessage parameter type is specified in 7.26. |
results [] | StatusCode | List of results for the acknowledgements (see 7.38 for StatusCode definition). The size and order of the list matches the size and order of the subscriptionAcknowledgements request parameter. |
diagnosticInfos [] | DiagnosticInfo | List of diagnostic information for the acknowledgements (see 7.12 for DiagnosticInfo definition). The size and order of the list matches the size and order of the subscriptionAcknowledgements 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. |