eBay::API::XML::DataType::PaginationResultType(3)

NAME
eBay::API::XML::DataType::PaginationResultType

DESCRIPTION
Shows the pagination of data returned by requests. Pagination of returned data is not needed in and not supported for every call. See the documentation for individual calls to determine whether pagination is supported, required, or desirable.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::PaginationResultType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setTotalNumberOfEntries()
Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.

# Argument: 'xs:int'

  getTotalNumberOfEntries()
  Calls: GetCategoryListings
         GetItemsAwaitingFeedback
         GetLiveAuctionBidders
         GetMemberMessages
         GetSellerPayments
         GetWantItNowSearchResults
  Returned: Always

  Calls: GetFeedback
  Returned: Always
  Details: DetailLevel: none, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetLiveAuctionBidders
         GetPopularKeywords
         GetVeROReportStatus
  Returned: Conditionally

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: BidList
           BestOfferList
           LostList
           WatchList
           WonList
           DeletedFromWonList
           DeletedFromLostList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: BidList
           ActiveList
           ScheduledList
           SoldList
           DeletedFromSoldList
           UnsoldList
           DeletedFromUnsoldList

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetSearchResults
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

  Calls: GetSellerList
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:int'

  setTotalNumberOfPages()
Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.

# Argument: 'xs:int'

  getTotalNumberOfPages()
  Calls: GetAccount
         GetCategoryListings
         GetItemsAwaitingFeedback
         GetMemberMessages
         GetSellerPayments
         GetWantItNowSearchResults
  Returned: Always

  Calls: GetFeedback
  Returned: Always
  Details: DetailLevel: none, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetLiveAuctionBidders
         GetPopularKeywords
         GetVeROReportStatus
  Returned: Conditionally

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: BidList
           BestOfferList
           LostList
           WatchList
           WonList
           DeletedFromWonList
           DeletedFromLostList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: ActiveList
           ScheduledList
           SoldList
           DeletedFromSoldList
           UnsoldList
           DeletedFromUnsoldList
           BidList

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetSearchResults
  Returned: Always
  Details: DetailLevel: ItemReturnCategories, ItemReturnAttributes, ReturnAll, none
           GranularityLevel: Coarse

  Calls: GetSellerList
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetUserDisputes
  Returned: Always
  Details: DetailLevel: ReturnSummary, ReturnAll, none

# Returns: 'xs:int'