|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetFeedbackCall
public class GetFeedbackCall
Wrapper class of the GetFeedback 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.
UserID
- The user's eBay User ID is specified in this field. If this field is used, all retrieved Feedback data will be for this eBay user. Specifies the user whose feedback data is to be returned. If this field is omitted in the call request, all retrieved Feedback records will be for the eBay user making the call.
FeedbackID
- The unique identifier of a Feedback record. This field is used if the user wants to retrieve a specific Feedback record. If FeedbackID is specified in the call request, all other input fields are ignored.
ItemID
- Unique identifier for an eBay item listing. A listing can have multiple order line items, but only one ItemID. If ItemID is specified in the GetFeedback request, the returned Feedback record(s) are restricted to the specified ItemID. The maximum number of Feedback records that can be returned is 100.
TransactionID
- Unique identifier for an eBay order line item (transaction). A
TransactionID can be paired up with its corresponding ItemID and used as
an input filter in the GetFeedback request. If an ItemID/TransactionID
pair or an OrderLineItemID value is used to retrieve a feedback record
on a specific order line item, the FeedbackType and Pagination
fields (if included) are ignored.
CommentType
- This field is used to retrieve Feedback records of a specific type (Positive, Negative, or Neutral) in FeedbackDetailArray. You can include one or two CommentType fields in the request. If no CommentType value is specified, Feedback records of all types are returned.
FeedbackType
- This field is used to restrict retrieved Feedback records to those that the user left for other buyers, Feedback records received as a seller, Feedback records received as a buyer, or Feedback records received as a buyer and seller. The default value is FeedbackReceived, so if the FeedbackType field is omitted in the request, all Feedback records received by the user as a buyer and seller are returned in the response. "Feedback Left" data will not be returned in the call response.
Pagination
- Controls the pagination of the result set. Child elements, EntriesPerPage and
PageNumber, specify the maximum number of individual feedback records to return
per call and which page of data to return. Only applicable if DetailLevel is
set to ReturnAll and the call is returning feedback for a UserID. Feedback
summary data is not paginated, but when pagination is used, it is returned
after the last feedback detail entry.
OrderLineItemID
- OrderLineItemID is a unique identifier for an eBay order line item and
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. An OrderLineItemID can be used as an
input filter in the GetFeedback request. If an OrderLineItemID value is
used to retrieve a feedback record on a specific order line item, the
FeedbackType and Pagination fields (if included) are ignored.
ReturnedFeedbackDetails
- Contains the individual feedback records for the user or order line item specified in the request. There is one FeedbackDetailType
object for each feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify FeedbackID in the request.
GrandTotal
- Indicates the number of FeedbackDetailType objects returned in the
FeedbackDetailArray property. Only applicable if feedback details are
returned.
FeedbackSummary
- Summary feedback data for the user. Contains counts of positive, neutral,
and negative feedback for pre-defined time periods. Only applicable if feedback details are returned.
FeedbackScore
- Indicates the total feedback score for the user.
ReturnedPaginationResult
- Contains information regarding the pagination of data (if pagination is
used), including total number of pages and total number of entries. This
is only applicable when a User ID or no ID (requester option) is specified.
ReturnedEntriesPerPage
- Indicates the number of entries (feedback detail) that are being
returned per page of data (i.e., per call).
Only returned if entries are returned.
ReturnedPageNumber
- Indicates which page of data was just returned. Will be the same as the
value specified in Pagination.PageNumber. (If the input is
higher than the total number of pages, the call fails with an error.)
Only returned if items are returned.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetFeedbackCall()
Constructor. |
|
GetFeedbackCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
CommentTypeCodeType[] |
getCommentType()
Gets the GetFeedbackRequestType.commentType. |
FeedbackDetailType[] |
getFeedback()
Retrieves one, many, or all Feedback records for a specific eBay user. |
String |
getFeedbackID()
Gets the GetFeedbackRequestType.feedbackID. |
int |
getFeedbackScore()
Valid after executing the API. |
FeedbackSummaryType |
getFeedbackSummary()
Valid after executing the API. |
FeedbackTypeCodeType |
getFeedbackType()
Gets the GetFeedbackRequestType.feedbackType. |
int |
getGrandTotal()
Valid after executing the API. |
String |
getItemID()
Gets the GetFeedbackRequestType.itemID. |
String |
getOrderLineItemID()
Gets the GetFeedbackRequestType.orderLineItemID. |
PaginationType |
getPagination()
Gets the GetFeedbackRequestType.pagination. |
Integer |
getReturnedEntriesPerPage()
Valid after executing the API. |
FeedbackDetailType[] |
getReturnedFeedbackDetails()
Valid after executing the API. |
Integer |
getReturnedPageNumber()
Valid after executing the API. |
PaginationResultType |
getReturnedPaginationResult()
Valid after executing the API. |
String |
getTransactionID()
Gets the GetFeedbackRequestType.transactionID. |
String |
getUserID()
Gets the GetFeedbackRequestType.userID. |
void |
setCommentType(CommentTypeCodeType[] commentType)
Sets the GetFeedbackRequestType.commentType. |
void |
setFeedbackID(String feedbackID)
Sets the GetFeedbackRequestType.feedbackID. |
void |
setFeedbackType(FeedbackTypeCodeType feedbackType)
Sets the GetFeedbackRequestType.feedbackType. |
void |
setItemID(String itemID)
Sets the GetFeedbackRequestType.itemID. |
void |
setOrderLineItemID(String orderLineItemID)
Sets the GetFeedbackRequestType.orderLineItemID. |
void |
setPagination(PaginationType pagination)
Sets the GetFeedbackRequestType.pagination. |
void |
setTransactionID(String transactionID)
Sets the GetFeedbackRequestType.transactionID. |
void |
setUserID(String userID)
Sets the GetFeedbackRequestType.userID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetFeedbackCall()
public GetFeedbackCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public FeedbackDetailType[] getFeedback() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public CommentTypeCodeType[] getCommentType()
public void setCommentType(CommentTypeCodeType[] commentType)
commentType
- CommentTypeCodeType[]public String getFeedbackID()
public void setFeedbackID(String feedbackID)
feedbackID
- Stringpublic FeedbackTypeCodeType getFeedbackType()
public void setFeedbackType(FeedbackTypeCodeType feedbackType)
feedbackType
- FeedbackTypeCodeTypepublic String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic String getOrderLineItemID()
public void setOrderLineItemID(String orderLineItemID)
orderLineItemID
- Stringpublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic String getTransactionID()
public void setTransactionID(String transactionID)
transactionID
- Stringpublic String getUserID()
public void setUserID(String userID)
userID
- Stringpublic int getFeedbackScore()
public FeedbackSummaryType getFeedbackSummary()
public int getGrandTotal()
public Integer getReturnedEntriesPerPage()
public FeedbackDetailType[] getReturnedFeedbackDetails()
public Integer getReturnedPageNumber()
public PaginationResultType getReturnedPaginationResult()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.