/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::AbstractResponseType

NAME

eBay::API::XML::DataType::AbstractResponseType

DESCRIPTION

Base type definition of a response payload that can carry any type of payload content with following optional elements:<br> - timestamp of response message<br> - application-level acknowledgement<br> - application-level (business-level) errors and warnings

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::AbstractResponseType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAck()

A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

# Argument: 'ns:AckCodeType'

getAck()

Calls:   Returned: Always
AllCallsExcept: CompleteSale, GetPopularKeywords
AllValuesExcept: PartialFailure

Calls: CompleteSale
       GetPopularKeywords
Returned: Always

# Returns: 'ns:AckCodeType'

setBotBlock()

Container of token, image URL and audio URL.

# Argument: 'ns:BotBlockResponseType'

getBotBlock()

Calls: PlaceOffer
Returned: Conditionally

# Returns: 'ns:BotBlockResponseType'

setBuild()

This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.

# Argument: 'xs:string'

getBuild()

Calls:   Returned: Always
AllCalls:

# Returns: 'xs:string'

setCorrelationID()

In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.<br> <br> <span class="tablenote"><b>Note:</b> GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. </span>

# Argument: 'xs:string'

getCorrelationID()

Calls:   Returned: Conditionally
AllCalls:

# Returns: 'xs:string'

setDuplicateInvocationDetails()

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

# Argument: 'ns:DuplicateInvocationDetailsType'

getDuplicateInvocationDetails()

Calls: AddItem
       AddLiveAuctionItem
       AddOrder
       AddSecondChanceItem
       AddToItemDescription
       PlaceOffer
       RelistItem
       ReviseCheckoutStatus
       ReviseItem
       ReviseLiveAuctionItem
Returned: Conditionally

# Returns: 'ns:DuplicateInvocationDetailsType'

setEIASToken()

Unique Identifier of Recipient user ID of the notification. Only returned by Platform Notifications (not for regular API call responses).

# Argument: 'xs:string'

getEIASToken()

# Returns: 'xs:string'

setErrors()

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

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ErrorHandling Title: Error Handling

# Argument: reference to an array of 'ns:ErrorType'

getErrors()

Calls:   Returned: Conditionally
AllCalls:

# Returns: reference to an array of 'ns:ErrorType'

setHardExpirationWarning()

Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.

# Argument: 'xs:string'

getHardExpirationWarning()

Calls:   Returned: Conditionally
AllCallsExcept: FetchToken

# Returns: 'xs:string'

setMessage()

Supplemental information from eBay, if applicable. May elaborate on errors or provide useful hints for the seller. This data can accompany the call's normal data result set or a result set that contains only errors. The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML- based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. Because this data is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,&lt;table&gt;&lt;tr&gt;...). See the appendices in the eBay Web Services guide for general information about string data types.

# Argument: 'xs:string'

getMessage()

Calls: AddItem
       AddLiveAuctionItem
       AddToItemDescription
       EndItem
       PlaceOffer
       RelistItem
       RespondToWantItNowPost
       ReviseItem
       ReviseLiveAuctionItem
       VerifyAddItem
Returned: Conditionally

# Returns: 'xs:string'

setNotificationEventName()

Event name of the notification. Only returned by Platform Notifications.

# Argument: 'xs:string'

getNotificationEventName()

# Returns: 'xs:string'

setNotificationSignature()

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

# Argument: 'xs:string'

getNotificationSignature()

# Returns: 'xs:string'

setRecipientUserID()

Recipient user ID of the notification. Only returned by Platform Notifications.

# Argument: 'xs:string'

getRecipientUserID()

# Returns: 'xs:string'

setTimestamp()

This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. <br> <br> <span class="tablenote"><b>Note:</b> GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.</span>

# Argument: 'xs:dateTime'

getTimestamp()

Calls:   Returned: Always
AllCalls:

# Returns: 'xs:dateTime'

setVersion()

The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

# Argument: 'xs:string'

getVersion()

Calls:   Returned: Always
AllCalls:

# Returns: 'xs:string'