Shopping_AbstractResponseType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Shopping_AbstractResponseType.h Shopping_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 ShoppingInterface
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 the “dateTime” type for information about this
time format and converting to and from the GMT time zone. -
ack
Indicates whether the call was successfully processed by eBay.
property -
errors
A list of application-level errors or warnings (if any) that were raised
property
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors. -
build
This refers to the particular software build that eBay used when
property
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. -
version
The release version that eBay used to process the request.
property
Note:
This is usually the latest release version, as specified in the
release notes. (eBay releases the API to international sites
about a week after we release it to the US site.)
If a field in the response returns the token “CustomCode”, it usually
means that the field is a code type (a token or enumeration),
and that in your request URL (or HTTP header) you specified a
version that is older than the version in which the token was added
to the call. -
correlationID
If you pass a value in MessageID in a request, we will return the same
property
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. Only returned if MessageID was used. -
any
(public property)
property
Properties
ack
Indicates whether the call was successfully processed by eBay.
@property (nonatomic, retain) NSString *ack
Discussion
Indicates whether the call was successfully processed by eBay.
type: string constant in Shopping_AckCodeType.h
Declared In
Shopping_AbstractResponseType.h
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Shopping_AbstractResponseType.h
build
This refers to the particular 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 particular 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
Shopping_AbstractResponseType.h
correlationID
If you pass a value in MessageID 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. Only returned if MessageID was used.
@property (nonatomic, retain) NSString *correlationID
Discussion
If you pass a value in MessageID 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. Only returned if MessageID was used.
type : NSString, wrapper for primitive string
Declared In
Shopping_AbstractResponseType.h
errors
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors.
@property (nonatomic, retain) NSMutableArray *errors
Discussion
A list of application-level errors or warnings (if any) that were raised
when eBay processed the request.
Application-level errors occur due to
problems with business-level data on the client side or on the eBay
server side. For example, an error would occur if the request contains
an invalid combination of fields, or it is missing a required field,
or the value of the field is not recognized. An error could also occur
if eBay encountered a problem in our internal business logic while
processing the request.
Only returned if there were warnings or errors.
entry type : class Shopping_ErrorType
Declared In
Shopping_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 the “dateTime” type for information about this
time format and converting to and from the GMT time zone.
@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 the “dateTime” type for information about this
time format and converting to and from the GMT time zone.
type : NSDate, wrapper for primitive date
Declared In
Shopping_AbstractResponseType.h
version
The release version that eBay used to process the request.
Note:
This is usually the latest release version, as specified in the
release notes. (eBay releases the API to international sites
about a week after we release it to the US site.)
If a field in the response returns the token “CustomCode”, it usually
means that the field is a code type (a token or enumeration),
and that in your request URL (or HTTP header) you specified a
version that is older than the version in which the token was added
to the call.
@property (nonatomic, retain) NSString *version
Discussion
The release version that eBay used to process the request.
Note:
This is usually the latest release version, as specified in the
release notes. (eBay releases the API to international sites
about a week after we release it to the US site.)
If a field in the response returns the token “CustomCode”, it usually
means that the field is a code type (a token or enumeration),
and that in your request URL (or HTTP header) you specified a
version that is older than the version in which the token was added
to the call.
type : NSString, wrapper for primitive string
Declared In
Shopping_AbstractResponseType.h