Changes since
the last release

com.ebay.sdk.call
Class GetFeedbackCall

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

public class GetFeedbackCall
extends ApiCall

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.


Input property: 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.
Input property: 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.
Input property: ItemID - Unique identifier for an eBay 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.
Input property: TransactionID - Unique identifier for an eBay order line item. 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.
Input property: 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.
Input property: 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.
Input property: 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.

Accepted values for Pagination.EntriesPerPage for GetFeedback is 25 (the default), 50, 100, and 200. If you specify a value of zero, or a value greater than 200, the call fails with an error. If you specify a value between one and twenty-four, the value is rounded up to 25. Values between 26 and 199 that are not one of the accepted values are rounded down to the nearest accepted value.
Input property: OrderLineItemID - OrderLineItemID is a unique identifier for an eBay order line item. 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.
Output property: ReturnedFeedbackDetails - Contains the individual Feedback records for the user or order line item specified in the request. There is one FeedbackDetail container returned for each Feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify a FeedbackID in the request.
Output property: GrandTotal - Indicates the total number of Feedback records returned in the the response. Only applicable if Feedback details are returned.
Output property: 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.
Output property: FeedbackScore - Indicates the total Feedback score for the user.
Output property: ReturnedPaginationResult - Contains information regarding the pagination of data, including the total number of Feedback entries and the total number of pages required to show all of these Feedback entries. The total number of pages is dependent on the Pagination.EntriesPerPage value (if set). The EntriesPerPage value defaults to 25 if the Pagination.EntriesPerPage field is not used.

If the call request returns no Feedback entries because there are none, or because the DetailLevel field was not included and set to ReturnAll, the PaginationResult.TotalNumberOfPages and PaginationResult.TotalNumberOfEntries fields are still returned, but with values of 0.
Output property: ReturnedEntriesPerPage - Indicates the number of Feedback records that are set to be returned per page of data (i.e., per call). The EntriesPerPage value defaults to 25 if the Pagination.EntriesPerPage field is not set in the request.

This field is always returned even if the response is not showing any Feedback entries.
Output property: ReturnedPageNumber - Indicates the page of data that is currently displaying. The page number to display is set in the Pagination.PageNumber field in the request. If this field is omitted, the PageNumber value defaults to 1 (first page of Feedback entries). If the integer value input into the Pagination.PageNumber field in the request is higher than the total number of available pages, the call fails with an error.

This field is always returned even if the response is not showing any Feedback entries.

Version:
1.0
Author:
Ron Murphy

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.
 java.lang.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.
 java.lang.String getItemID()
          Gets the GetFeedbackRequestType.itemID.
 java.lang.String getOrderLineItemID()
          Gets the GetFeedbackRequestType.orderLineItemID.
 PaginationType getPagination()
          Gets the GetFeedbackRequestType.pagination.
 java.lang.Integer getReturnedEntriesPerPage()
          Valid after executing the API.
 FeedbackDetailType[] getReturnedFeedbackDetails()
          Valid after executing the API.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 PaginationResultType getReturnedPaginationResult()
          Valid after executing the API.
 java.lang.String getTransactionID()
          Gets the GetFeedbackRequestType.transactionID.
 java.lang.String getUserID()
          Gets the GetFeedbackRequestType.userID.
 void setCommentType(CommentTypeCodeType[] commentType)
          Sets the GetFeedbackRequestType.commentType.
 void setFeedbackID(java.lang.String feedbackID)
          Sets the GetFeedbackRequestType.feedbackID.
 void setFeedbackType(FeedbackTypeCodeType feedbackType)
          Sets the GetFeedbackRequestType.feedbackType.
 void setItemID(java.lang.String itemID)
          Sets the GetFeedbackRequestType.itemID.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the GetFeedbackRequestType.orderLineItemID.
 void setPagination(PaginationType pagination)
          Sets the GetFeedbackRequestType.pagination.
 void setTransactionID(java.lang.String transactionID)
          Sets the GetFeedbackRequestType.transactionID.
 void setUserID(java.lang.String userID)
          Sets the GetFeedbackRequestType.userID.
 
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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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

GetFeedbackCall

public GetFeedbackCall()
Constructor.


GetFeedbackCall

public GetFeedbackCall(ApiContext apiContext)
Constructor.

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

getFeedback

public FeedbackDetailType[] getFeedback()
                                 throws ApiException,
                                        SdkException,
                                        java.lang.Exception
Retrieves one, many, or all Feedback records for a specific eBay user. There is a filter option in the call request to limit Feedback records to those that are received, or to those that are left for other buyers, as well as a filter option to limit Feedback records to those that are received as a buyer or seller.

Returns:
The FeedbackDetailType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getCommentType

public CommentTypeCodeType[] getCommentType()
Gets the GetFeedbackRequestType.commentType.

Returns:
CommentTypeCodeType[]

setCommentType

public void setCommentType(CommentTypeCodeType[] commentType)
Sets the GetFeedbackRequestType.commentType.

Parameters:
commentType - CommentTypeCodeType[]

getFeedbackID

public java.lang.String getFeedbackID()
Gets the GetFeedbackRequestType.feedbackID.

Returns:
String

setFeedbackID

public void setFeedbackID(java.lang.String feedbackID)
Sets the GetFeedbackRequestType.feedbackID.

Parameters:
feedbackID - String

getFeedbackType

public FeedbackTypeCodeType getFeedbackType()
Gets the GetFeedbackRequestType.feedbackType.

Returns:
FeedbackTypeCodeType

setFeedbackType

public void setFeedbackType(FeedbackTypeCodeType feedbackType)
Sets the GetFeedbackRequestType.feedbackType.

Parameters:
feedbackType - FeedbackTypeCodeType

getItemID

public java.lang.String getItemID()
Gets the GetFeedbackRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetFeedbackRequestType.itemID.

Parameters:
itemID - String

getOrderLineItemID

public java.lang.String getOrderLineItemID()
Gets the GetFeedbackRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(java.lang.String orderLineItemID)
Sets the GetFeedbackRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getPagination

public PaginationType getPagination()
Gets the GetFeedbackRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetFeedbackRequestType.pagination.

Parameters:
pagination - PaginationType

getTransactionID

public java.lang.String getTransactionID()
Gets the GetFeedbackRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(java.lang.String transactionID)
Sets the GetFeedbackRequestType.transactionID.

Parameters:
transactionID - String

getUserID

public java.lang.String getUserID()
Gets the GetFeedbackRequestType.userID.

Returns:
String

setUserID

public void setUserID(java.lang.String userID)
Sets the GetFeedbackRequestType.userID.

Parameters:
userID - String

getFeedbackScore

public int getFeedbackScore()
Valid after executing the API. Gets the returned GetFeedbackResponseType.feedbackScore.

Returns:
int

getFeedbackSummary

public FeedbackSummaryType getFeedbackSummary()
Valid after executing the API. Gets the returned GetFeedbackResponseType.feedbackSummary.

Returns:
FeedbackSummaryType

getGrandTotal

public int getGrandTotal()
Valid after executing the API. Gets the returned GetFeedbackResponseType.grandTotal.

Returns:
int

getReturnedEntriesPerPage

public java.lang.Integer getReturnedEntriesPerPage()
Valid after executing the API. Gets the returned GetFeedbackResponseType.returnedEntriesPerPage.

Returns:
Integer

getReturnedFeedbackDetails

public FeedbackDetailType[] getReturnedFeedbackDetails()
Valid after executing the API. Gets the returned GetFeedbackResponseType.returnedFeedbackDetails.

Returns:
FeedbackDetailType[]

getReturnedPageNumber

public java.lang.Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetFeedbackResponseType.returnedPageNumber.

Returns:
Integer

getReturnedPaginationResult

public PaginationResultType getReturnedPaginationResult()
Valid after executing the API. Gets the returned GetFeedbackResponseType.returnedPaginationResult.

Returns:
PaginationResultType

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.