Trading_AbstractResponseType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_AbstractResponseType.h Trading_AbstractResponseType.m |
Overview
Base type definition of a response payload that can carry any
type of payload content with following optional elements:
- timestamp of response message
- application-level acknowledgement
- application-level (business-level) errors and warnings
@ingroup EBayAPIInterface
Tasks
-
timestamp
This value represents the date and time when eBay processed the
property
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.
Note:
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. -
ack
A token representing the application-level acknowledgement code that indicates
property
the response status (e.g., success). The AckCodeType list specifies
the possible values for Ack. -
correlationID
Most Trading API calls support a MessageID element in the request
property
and a CorrelationID element in the response. If you pass in a
MessageID in a request, the same value will be returned in the
CorrelationID field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a MessageID value in the request,
CorrelationID is not returned.
Note:
GetCategories is 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.
-
errors
A list of application-level errors (if any) that occurred when eBay
property
processed the request. -
message
Supplemental information from eBay, if applicable. May elaborate on
property
errors (such as how a listing violates eBay policies) or provide
useful hints that may help a seller increase sales. This data can
accompany the call’s normal data result set or a result set that
contains only errors.
Applications must recognize when the Message field is returned and
provide a means to display the listing hints and error message
explanations to the user.
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.
As usual for string data types, the HTML markup elements are escaped
with character entity references
(e.g.,<table><tr>…). -
version
The version of the response payload schema. Indicates the version of the
property
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. -
build
This refers to the specific software build that eBay used when processing the request
property
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. -
notificationEventName
Event name of the notification. Only returned by Platform Notifications.
property -
duplicateInvocationDetails
Information that explains a failure due to a duplicate InvocationID being
property
passed in. -
recipientUserID
Recipient user ID of the notification. Only returned by Platform Notifications.
property -
eiasToken
Unique Identifier of Recipient user ID of the notification. Only returned by
property
Platform Notifications (not for regular API call responses). -
notificationSignature
A Base64-encoded MD5 hash that allows the recipient of a Platform
property
Notification to verify this is a valid Platform Notification sent by
eBay. -
hardExpirationWarning
Expiration date of the user’s authentication token. Only returned
property
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. -
botBlock
Container of token, image URL and audio URL.
property -
externalUserData
An application subscribing to notifications can include an XML-compliant
property
string, not to exceed 256 characters, which will be returned. The string can
identify a particular user. Any sensitive information should be passed with due
caution.
To subscribe to and receive eBay Buyer Protection notifications, this field is
required, and you must pass in ‘eBP notification’ as a string. -
any
(public property)
property
Properties
ack
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.
@property (nonatomic, retain) NSString *ack
Discussion
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.
type: string constant in Trading_AckCodeType.h
Declared In
Trading_AbstractResponseType.h
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_AbstractResponseType.h
botBlock
Container of token, image URL and audio URL.
@property (nonatomic, retain) Trading_BotBlockResponseType *botBlock
Declared In
Trading_AbstractResponseType.h
build
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.
@property (nonatomic, retain) NSString *build
Discussion
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.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
correlationID
Most Trading API calls support a MessageID element in the request
and a CorrelationID element in the response. If you pass in a
MessageID in a request, the same value will be returned in the
CorrelationID field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a MessageID value in the request,
CorrelationID is not returned.
Note:
GetCategories is 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.
@property (nonatomic, retain) NSString *correlationID
Discussion
Most Trading API calls support a MessageID element in the request
and a CorrelationID element in the response. If you pass in a
MessageID in a request, the same value will be returned in the
CorrelationID field in the response. Pairing these values can
help you track and confirm that a response is returned for every request and to
match specific responses to specific requests.
If you do not pass a MessageID value in the request,
CorrelationID is not returned.
Note:
GetCategories is 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.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
duplicateInvocationDetails
Information that explains a failure due to a duplicate InvocationID being
passed in.
@property (nonatomic, retain) Trading_DuplicateInvocationDetailsType *duplicateInvocationDetails
Discussion
Information that explains a failure due to a duplicate InvocationID being
passed in.
type : class Trading_DuplicateInvocationDetailsType
Declared In
Trading_AbstractResponseType.h
eiasToken
Unique Identifier of Recipient user ID of the notification. Only returned by
Platform Notifications (not for regular API call responses).
@property (nonatomic, retain) NSString *eiasToken
Discussion
Unique Identifier of Recipient user ID of the notification. Only returned by
Platform Notifications (not for regular API call responses).
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
errors
A list of application-level errors (if any) that occurred when eBay
processed the request.
@property (nonatomic, retain) NSMutableArray *errors
Discussion
A list of application-level errors (if any) that occurred when eBay
processed the request.
entry type : class Trading_ErrorType
Declared In
Trading_AbstractResponseType.h
externalUserData
An application subscribing to notifications can include an XML-compliant
string, not to exceed 256 characters, which will be returned. The string can
identify a particular user. Any sensitive information should be passed with due
caution.
To subscribe to and receive eBay Buyer Protection notifications, this field is
required, and you must pass in ‘eBP notification’ as a string.
@property (nonatomic, retain) NSString *externalUserData
Discussion
An application subscribing to notifications can include an XML-compliant
string, not to exceed 256 characters, which will be returned. The string can
identify a particular user. Any sensitive information should be passed with due
caution.
To subscribe to and receive eBay Buyer Protection notifications, this field is
required, and you must pass in ‘eBP notification’ as a string.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
hardExpirationWarning
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.
@property (nonatomic, retain) NSString *hardExpirationWarning
Discussion
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.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
message
Supplemental information from eBay, if applicable. May elaborate on
errors (such as how a listing violates eBay policies) or provide
useful hints that may help a seller increase sales. This data can
accompany the call’s normal data result set or a result set that
contains only errors.
Applications must recognize when the Message field is returned and
provide a means to display the listing hints and error message
explanations to the user.
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.
As usual for string data types, the HTML markup elements are escaped
with character entity references
(e.g.,<table><tr>…).
@property (nonatomic, retain) NSString *message
Discussion
Supplemental information from eBay, if applicable. May elaborate on
errors (such as how a listing violates eBay policies) or provide
useful hints that may help a seller increase sales. This data can
accompany the call’s normal data result set or a result set that
contains only errors.
Applications must recognize when the Message field is returned and
provide a means to display the listing hints and error message
explanations to the user.
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.
As usual for string data types, the HTML markup elements are escaped
with character entity references
(e.g.,<table><tr>…).
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
notificationEventName
Event name of the notification. Only returned by Platform Notifications.
@property (nonatomic, retain) NSString *notificationEventName
Discussion
Event name of the notification. Only returned by Platform Notifications.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
notificationSignature
A Base64-encoded MD5 hash that allows the recipient of a Platform
Notification to verify this is a valid Platform Notification sent by
eBay.
@property (nonatomic, retain) NSString *notificationSignature
Discussion
A Base64-encoded MD5 hash that allows the recipient of a Platform
Notification to verify this is a valid Platform Notification sent by
eBay.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
recipientUserID
Recipient user ID of the notification. Only returned by Platform Notifications.
@property (nonatomic, retain) NSString *recipientUserID
Discussion
Recipient user ID of the notification. Only returned by Platform Notifications.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h
timestamp
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.
Note:
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.
@property (nonatomic, retain) NSDate *timestamp
Discussion
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.
Note:
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_AbstractResponseType.h
version
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.
@property (nonatomic, retain) NSString *version
Discussion
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.
type : NSString, wrapper for primitive string
Declared In
Trading_AbstractResponseType.h