Changes since
the last release

com.ebay.sdk.call
Class GetNotificationsUsageCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetNotificationsUsageCall

public class GetNotificationsUsageCall
extends ApiCall

Wrapper class of the GetNotificationsUsage call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: StartTime - Specifies the start date and time for which notification information will be retrieved. StartTime is optional. If no StartTime is specified, the default value of 24 hours prior to the call time is used. If no StartTime is specified or if an invalid StartTime is specified, date range errors are returned in the response. For a StartTime to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the EndTime, and it cannot be later than the time of the call. If an invalid StartTime is specified, the default value is used.
Input property: EndTime - Specifies the end date and time for which notification information will be retrieved. EndTime is optional.

If no EndTime is specified, the current time (the time the call is made) is used. If no EndTime is specified or if an invalid EndTime is specified, date range errors are returned in the response. For an EndTime to be valid, it must be no more than 72 hours before the time the of the call, it cannot be before the StartTime, and it cannot be later than the time of the call. If an invalid EndTime is specified, the current time is used.
Input property: ItemID - Specifies an item ID for which detailed notification information will be retrieved. ItemID is optional. If no ItemID is specified, the response will not include any individual notification details.
Output property: ReturnedStartTime - Returns the start date and time for the notification information that is returned by this call.
Output property: ReturnedEndTime - Returns the end date and time for the notification information that is returned by this call.
Output property: ReturnedNotificationDetailsArray - 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.
Output property: ReturnedMarkUpMarkDownHistory - List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned.
Output property: ReturnedNotificationStatistics - 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).

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetNotificationsUsageCall()
          Constructor.
GetNotificationsUsageCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 Calendar getEndTime()
          Gets the GetNotificationsUsageRequestType.endTime.
 String getItemID()
          Gets the GetNotificationsUsageRequestType.itemID.
 void getNotificationsUsage()
          Retrieves usage information about platform notifications for a given application.
 Calendar getReturnedEndTime()
          Valid after executing the API.
 MarkUpMarkDownHistoryType getReturnedMarkUpMarkDownHistory()
          Valid after executing the API.
 NotificationDetailsArrayType getReturnedNotificationDetailsArray()
          Valid after executing the API.
 NotificationStatisticsType getReturnedNotificationStatistics()
          Valid after executing the API.
 Calendar getReturnedStartTime()
          Valid after executing the API.
 Calendar getStartTime()
          Gets the GetNotificationsUsageRequestType.startTime.
 void setEndTime(Calendar endTime)
          Sets the GetNotificationsUsageRequestType.endTime.
 void setItemID(String itemID)
          Sets the GetNotificationsUsageRequestType.itemID.
 void setStartTime(Calendar startTime)
          Sets the GetNotificationsUsageRequestType.startTime.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetNotificationsUsageCall

public GetNotificationsUsageCall()
Constructor.


GetNotificationsUsageCall

public GetNotificationsUsageCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getNotificationsUsage

public void getNotificationsUsage()
                           throws ApiException,
                                  SdkException,
                                  Exception
Retrieves usage information about platform notifications for a given application. You can use this notification information to troubleshoot issues with platform notifications. You can call this up to 50 times per hour for a given application.

Throws:
ApiException
SdkException
Exception

getEndTime

public Calendar getEndTime()
Gets the GetNotificationsUsageRequestType.endTime.

Returns:
Calendar

setEndTime

public void setEndTime(Calendar endTime)
Sets the GetNotificationsUsageRequestType.endTime.

Parameters:
endTime - Calendar

getItemID

public String getItemID()
Gets the GetNotificationsUsageRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the GetNotificationsUsageRequestType.itemID.

Parameters:
itemID - String

getStartTime

public Calendar getStartTime()
Gets the GetNotificationsUsageRequestType.startTime.

Returns:
Calendar

setStartTime

public void setStartTime(Calendar startTime)
Sets the GetNotificationsUsageRequestType.startTime.

Parameters:
startTime - Calendar

getReturnedEndTime

public Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned GetNotificationsUsageResponseType.returnedEndTime.

Returns:
Calendar

getReturnedMarkUpMarkDownHistory

public MarkUpMarkDownHistoryType getReturnedMarkUpMarkDownHistory()
Valid after executing the API. Gets the returned GetNotificationsUsageResponseType.returnedMarkUpMarkDownHistory.

Returns:
MarkUpMarkDownHistoryType

getReturnedNotificationDetailsArray

public NotificationDetailsArrayType getReturnedNotificationDetailsArray()
Valid after executing the API. Gets the returned GetNotificationsUsageResponseType.returnedNotificationDetailsArray.

Returns:
NotificationDetailsArrayType

getReturnedNotificationStatistics

public NotificationStatisticsType getReturnedNotificationStatistics()
Valid after executing the API. Gets the returned GetNotificationsUsageResponseType.returnedNotificationStatistics.

Returns:
NotificationStatisticsType

getReturnedStartTime

public Calendar getReturnedStartTime()
Valid after executing the API. Gets the returned GetNotificationsUsageResponseType.returnedStartTime.

Returns:
Calendar

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.