complexType "GetNotificationsUsageResponseType"

Component	Type / Value	Occurs	Required?	Nillable?	Description
SEQUENCE		1..1	yes
Timestamp	dateTime	0..1	no	no	This value represents the date and time when eBay processed the request. »
Ack	AckCodeType : enumeration of token	0..1	no	no	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). »
CorrelationID	string	0..1	no	no	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »
Errors	ErrorType	0..∞	no	no	A list of application-level errors (if any) that occurred when eBay processed the request.
Message	string	0..1	no	no	Supplemental information from eBay, if applicable. »
Version	string	0..1	no	no	The version of the response payload schema. »
Build	string	0..1	no	no	This refers to the specific software build that eBay used when processing the request and generating the response. »
NotificationEventName	string	0..1	no	no	Event name of the notification. »
DuplicateInvocationDetails	DuplicateInvocationDetailsType	0..1	no	no	Information that explains a failure due to a duplicate InvocationID being passed in.
RecipientUserID	string	0..1	no	no	Recipient user ID of the notification. »
EIASToken	string	0..1	no	no	Unique Identifier of Recipient user ID of the notification. »
NotificationSignature	string	0..1	no	no	A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay.
HardExpirationWarning	string	0..1	no	no	Expiration date of the user's authentication token. »
BotBlock	BotBlockResponseType	0..1	no	no	This container is conditionally returned in the PlaceOffer call response if eBay wants to challenge the user making the call to ensure that the call is being made by a real user and not a bot. »
ExternalUserData	string	0..1	no	no	An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. »
{any}	from any namespace	0..∞	no
StartTime	dateTime	0..1	no	no	Returns the start date and time for the notification information that is returned by this call.
EndTime	dateTime	0..1	no	no	Returns the end date and time for the notification information that is returned by this call.
NotificationDetailsArray	NotificationDetailsArrayType	0..1	no	no	List of notification objects representing the notifications sent to an application for the given time period.
MarkUpMarkDownHistory	MarkUpMarkDownHistoryType	0..1	no	no	List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned.
NotificationStatistics	NotificationStatisticsType	0..1	no	no	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

Type / Value

Occurs

Required?

Nillable?

Description

SEQUENCE

1..1

yes

Timestamp

dateTime

0..1

This value represents the date and time when eBay processed the request. »

Ack

AckCodeType : enumeration of token

0..1

A token representing the application-level acknowledgement code that indicates the response status (e.g., success). »

CorrelationID

string

0..1

Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »

Errors

ErrorType

0..∞

A list of application-level errors (if any) that occurred when eBay processed the request.

Message

string

0..1

Supplemental information from eBay, if applicable. »

Version

string

0..1

The version of the response payload schema. »

Build

string

0..1

This refers to the specific software build that eBay used when processing the request and generating the response. »

NotificationEventName

string

0..1

Event name of the notification. »

DuplicateInvocationDetails

DuplicateInvocationDetailsType

0..1

Information that explains a failure due to a duplicate InvocationID being passed in.

RecipientUserID

string

0..1

Recipient user ID of the notification. »

EIASToken

string

0..1

Unique Identifier of Recipient user ID of the notification. »

NotificationSignature

string

0..1

A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay.

HardExpirationWarning

string

0..1

Expiration date of the user's authentication token. »

BotBlock

BotBlockResponseType

0..1

This container is conditionally returned in the PlaceOffer call response if eBay wants to challenge the user making the call to ensure that the call is being made by a real user and not a bot. »

ExternalUserData

string

0..1

An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. »

{any}

from any namespace

0..∞

StartTime

dateTime

0..1

Returns the start date and time for the notification information that is returned by this call.

EndTime

dateTime

0..1

Returns the end date and time for the notification information that is returned by this call.

NotificationDetailsArray

NotificationDetailsArrayType

0..1

List of notification objects representing the notifications sent to an application for the given time period.

MarkUpMarkDownHistory

MarkUpMarkDownHistoryType

0..1

List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned.

NotificationStatistics

NotificationStatisticsType

0..1

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).

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.

Web-Service	Methods
eBayAPIInterfaceService	GetNotificationsUsage

Web-Service

Methods

eBayAPIInterfaceService

GetNotificationsUsage

Namespace:	urn:ebay:apis:eBLBaseComponents
Derived By:	extension of AbstractResponseType
Content:	complex, 20 elements, elem. wildcard
Defined:	in ebaySvc.wsdl/Schema
Includes:	declarations of 5 elements
Referenced:	by 2 locations