GrooveEvents.ReadSummary Operation
The ReadSummary operation returns a summary of the event queue, including a list of event sources that have events in the queue. You can use the information as a low-overhead way to determine if there are any new events of interest without actually reading the events themselves.
HTTP Post URL
The HTTP Post URL targets the service. This is a top-level HTTP Post URL that you supply directly; it is not returned as a value by another operation.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<CallbackURI />
<IncludeSources />
| Element | Data type | Description |
|---|---|---|
CallbackURI |
|
Identifies the subscription by the CallbackURI specified in the GrooveSubscriptions.Create or GrooveSubscriptions.CreateAggregated2 operation. The CallbackURI must start with " |
IncludeSources |
|
If TRUE, the list of event sources is included in the output. Otherwise it is not. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ReadSummaryResult />
| Element | Data type | Description |
|---|---|---|
ReadSummaryResult |
Provides summary information about the event queue. |
See Also
Reference
GrooveEvents Web Service
GrooveEvents.Delete Operation