complexType "ns:GetNotificationsUsageResponseType"
Namespace: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
XML Representation Summary |
<...> |
|
Content: |
ns:Timestamp?, ns:Ack?, ns:CorrelationID?, ns:Errors*, ns:Message?, ns:Version?, ns:Build?, ns:NotificationEventName?, ns:DuplicateInvocationDetails?, ns:RecipientUserID?, ns:EIASToken?, ns:NotificationSignature?, ns:HardExpirationWarning?, ns:BotBlock?, ns:ExternalUserData?, {any}*, ns:StartTime?, ns:EndTime?, ns:NotificationDetailsArray?, ns:MarkUpMarkDownHistory?, ns:NotificationStatistics?
|
|
</...> |
All Direct / Indirect Based Elements (1):
-
Returns an array of notifications sent to a given application identified by the appID (comes in the credentials). The result can be used by third-party developers troubleshoot issues with notifications.
Zero, one or many notifications can be returned in the array. The set of notifications returned is limited to those that were sent between the StartTime and EndTime specified in the request.
If StartTime or EndTime filters were not found in the request, then the response will contain the data for only one day (Now-1day). By default, maximum duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies to Notifications, MarkDownMarkUpHistory and NotificationStatistics.
Notifications are sent only if the ItemID is included in the request. If there is no ItemID, then only Statistics and MarkDownMarkUpHistory information is included.
XML Source (w/o annotations (6); see within schema source)
<xs:complexContent>
<xs:extension base="ns:AbstractResponseType">
<xs:sequence>
<xs:element minOccurs="0" name="StartTime" type="xs:dateTime"/>
<xs:element minOccurs="0" name="EndTime" type="xs:dateTime"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
|
Content Element Detail (all declarations defined in this component; 5/21)
ns:EndTime
-
Type: |
xs:dateTime, predefined, simple content
|
Returns the end date and time for the notification information that is
returned by this call.
XML Representation Summary
<ns:EndTime> |
|
|
</ns:EndTime> |
|
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="EndTime" type="xs:dateTime"/>
|
ns:MarkUpMarkDownHistory
-
List of objects representing MarkUp or MarkDown history for a given appID
and for given StartTime and EndTime. This node will always be returned.
Component Diagram
XML Representation Summary
<ns:MarkUpMarkDownHistory> |
|
|
</ns:MarkUpMarkDownHistory> |
|
XML Source (w/o annotations (1); see within schema source)
ns:NotificationDetailsArray
-
List of notification objects representing the notifications sent to an
application for the given time period. It will only be returned if ItemID
was specified in the input request.
Component Diagram
XML Representation Summary
<ns:NotificationDetailsArray> |
|
|
</ns:NotificationDetailsArray> |
|
XML Source (w/o annotations (1); see within schema source)
ns:NotificationStatistics
-
Summary information about number of notifications that were successfully
delivered, queued, failed, connection attempts made, connection timeouts,
http errors for the given appID and given time period. By default, statistics
for only one day (Now-1day) is included. Maximum time duration allowed is 3 days
(Now-3days).
Component Diagram
XML Representation Summary
<ns:NotificationStatistics> |
|
|
</ns:NotificationStatistics> |
|
XML Source (w/o annotations (1); see within schema source)
ns:StartTime
-
Type: |
xs:dateTime, predefined, simple content
|
Returns the start date and time for the notification information that is
returned by this call.
XML Representation Summary
<ns:StartTime> |
|
|
</ns:StartTime> |
|
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="StartTime" type="xs:dateTime"/>
|