Component 
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API

complexType "ns:GetAllBiddersRequestType"
Namespace:
Content:
complex, 13 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 3 elements
Used:
Component Diagram
XML Representation Summary
<...>
   
Content: 
</...>
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
This is the base request type for the GetAllBidders call, which is used to retrieve bidders from an active or recently-ended auction listing.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:GetAllBiddersRequestType
XML Source (w/o annotations (4); see within schema source)
<xs:complexType name="GetAllBiddersRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>
<xs:element minOccurs="0" name="CallMode" type="ns:GetAllBiddersModeCodeType"/>
<xs:element minOccurs="0" name="IncludeBiddingSummary" type="xs:boolean"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 3/14)
ns:CallMode
Type:
The enumeration value that is passed into this field will control the set of bidders that will be retrieved in the response. To retrieve bidders from a recently-ended auction listing, any of the three values can be used. To retrieve bidders for an active auction listing, only the ViewAll enumeration value can be used. These values are discussed in GetAllBiddersModeCodeType.
XML Representation Summary
<ns:CallMode>
   
Content: 
{ enumeration of xs:token }
</ns:CallMode>
Simple Content
Enumeration:
"ViewAll"
 - 
This enumeration value is used if the user wants to retrieve all bidders on an active or recently-ended auction listing. This value can be used by any user, and it is the default value if the CallMode field is not included in the call request.
"EndedListing"
 - 
This enumeration value is used if the user wants to retrieve all non-winning bidders for a recently-ended auction listing. This value can be only be used by the seller of the item.
"SecondChanceEligibleEndedListing"
 - 
This enumeration value is used if the user wants to retrieve all non-winning bidders, for a recently-ended auction listing, who are eligible for, and who accept Second Chance Offers. This value can be only be used by the seller of the item. See <"http://pages.ebay.com/help/sell/second_chance_offer.html#when" target="_blank">When to use a Second Chance Offer for more information on Second Chance Offers.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CallMode" type="ns:GetAllBiddersModeCodeType"/>

ns:IncludeBiddingSummary
Type:
xs:boolean, predefined, simple content
The user must include this field and set its value to true if the user wishes to retrieve the BiddingSummary container for each bidder. The BiddingSummary container consists of more detailed bidding information on each bidder.
XML Representation Summary
<ns:IncludeBiddingSummary>
   
Content: 
{ xs:boolean }
</ns:IncludeBiddingSummary>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="IncludeBiddingSummary" type="xs:boolean"/>

ns:ItemID
Type:
ns:ItemIDType, simple content
This is the unique identifier of the auction listing for which bidders are being retrieved. This auction listing can be active or recently ended. However, to retrieve bidders for an active auction listing, the only CallMode enumeration value that can be used is ViewAll.
XML Representation Summary
<ns:ItemID>
   
Content: 
{ xs:string }
</ns:ItemID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

 Component 
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.