Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:CharityInfoType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 1 attribute, 22 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 1 attribute, 22 elements, elem. wildcard
Used:
at 1 location
Component Diagram
XML Representation Summary
<...
   
id
 = 
xs:string
   
>
   
Content: 
ns:Name?, ns:ListingNPEmailNotifPref?, ns:ListingNPEmail?, ns:ListingNPContactName?, ns:Mission?, ns:LogoURL?, ns:Status?, ns:SearchableString?, ns:CharityRegion?, ns:CharityDomain[0..3], ns:CharityID?, ns:LogoURLSelling?, ns:DisplayLogoSelling?, ns:DisplayNameInCheckout?, ns:Description?, ns:ShowMultipleDonationAmountInCheckout?, ns:ExternalID?, ns:PopularityIndex?, ns:EIN?, ns:NonProfitSecondName?, ns:NonProfitAddress*, ns:NonProfitSocialAddress*, {any}*
</...>
All Direct / Indirect Based Elements (1):
ns:Charity (in ns:GetCharitiesResponse)
Known Usage Locations
Annotation
Type defining the Charity container returned in GetCharities, which consists of all details related to a nonprofit charity organization.
XML Source (w/o annotations (24); see within schema source)
<xs:complexType name="CharityInfoType">
<xs:sequence>
<xs:element minOccurs="0" name="Name" type="xs:string"/>
<!-- change start -->
<xs:element minOccurs="0" name="ListingNPEmailNotifPref" type="xs:boolean"/>
<xs:element minOccurs="0" name="ListingNPEmail" type="xs:string"/>
<xs:element minOccurs="0" name="ListingNPContactName" type="xs:string"/>
<!-- change end -->
<xs:element minOccurs="0" name="Mission" type="xs:string"/>
<xs:element minOccurs="0" name="LogoURL" type="xs:anyURI"/>
<xs:element minOccurs="0" name="Status" type="ns:CharityStatusCodeType"/>
<xs:element minOccurs="0" name="SearchableString" type="xs:string"/>
<xs:element minOccurs="0" name="CharityRegion" type="xs:int"/>
<xs:element maxOccurs="3" minOccurs="0" name="CharityDomain" type="xs:int"/>
<xs:element minOccurs="0" name="CharityID" type="xs:string"/>
<xs:element minOccurs="0" name="LogoURLSelling" type="xs:anyURI"/>
<xs:element minOccurs="0" name="DisplayLogoSelling" type="xs:boolean"/>
<xs:element minOccurs="0" name="DisplayNameInCheckout" type="xs:boolean"/>
<xs:element minOccurs="0" name="Description" type="xs:string"/>
<xs:element minOccurs="0" name="ShowMultipleDonationAmountInCheckout" type="xs:boolean"/>
<xs:element minOccurs="0" name="ExternalID" type="xs:string"/>
<xs:element minOccurs="0" name="PopularityIndex" type="xs:int"/>
<xs:element minOccurs="0" name="EIN" type="xs:string"/>
<xs:element minOccurs="0" name="NonProfitSecondName" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="NonProfitAddress" type="ns:NonProfitAddressType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="NonProfitSocialAddress" type="ns:NonProfitSocialAddressType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
<xs:attribute name="id" type="xs:string"/>
</xs:complexType>
Attribute Detail (all declarations defined in this component; 1/1)
id
Type:
xs:string, predefined
Use:
optional
This attribute is the eBay-assigned, unique identifier of the nonprofit charity organization.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="id" type="xs:string"/>
Content Element Detail (all declarations defined in this component; 23/23)
ns:CharityDomain
Type:
xs:int, predefined, simple content
Integer value that indicates the domain (mission area) of the nonprofit charity organization. A nonprofit charity organization does not have to specify a charity domain, so it is possible that this field will not be returned in GetCharities. Each nonprofit charity organization can belong to as many as three charity domains.
XML Representation Summary
<ns:CharityDomain>
   
Content: 
{ xs:int }
</ns:CharityDomain>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="3" minOccurs="0" name="CharityDomain" type="xs:int"/>
ns:CharityID
Type:
xs:string, predefined, simple content
This field is no longer returned. eBay's unique identifier for nonprofit organizations is now returned in the id attribute of the the opening Charity tag instead.
XML Representation Summary
<ns:CharityID>
   
Content: 
{ xs:string }
</ns:CharityID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CharityID" type="xs:string"/>
ns:CharityRegion
Type:
xs:int, predefined, simple content
Integer value that indicates the nonprofit charity organization's region. Each nonprofit charity organization may only be associated with one region.
XML Representation Summary
<ns:CharityRegion>
   
Content: 
{ xs:int }
</ns:CharityRegion>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CharityRegion" type="xs:int"/>
ns:Description
Type:
xs:string, predefined, simple content
This field provides a description about the nonprofit charity organization's primary purpose. "I want to support" will be added to the beginning of the contents of this field. For example, if the description is "the fight against cancer", then on the checkout page "I want to support the fight against cancer" will be displayed. This field is returned if available for the nonprofit organization.
XML Representation Summary
<ns:Description>
   
Content: 
{ xs:string }
</ns:Description>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Description" type="xs:string"/>
ns:DisplayLogoSelling
Type:
xs:boolean, predefined, simple content
This boolean value indicates if the LogoURLSelling image will appear in the eBay for Charity section of the View Item page for a charitable listing.
XML Representation Summary
<ns:DisplayLogoSelling>
   
Content: 
{ xs:boolean }
</ns:DisplayLogoSelling>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DisplayLogoSelling" type="xs:boolean"/>
ns:DisplayNameInCheckout
Type:
xs:boolean, predefined, simple content
This field is deprecated.
XML Representation Summary
<ns:DisplayNameInCheckout>
   
Content: 
{ xs:boolean }
</ns:DisplayNameInCheckout>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DisplayNameInCheckout" type="xs:boolean"/>
ns:EIN
Type:
xs:string, predefined, simple content
This value is the Employer Identification Number (EIN) of the nonprofit charity organization. A nonprofit company's EIN is used for tax purposes by the Internal Revenue Service. This value is returned if the nonprofit organization has an EIN and it has been set.
XML Representation Summary
<ns:EIN>
   
Content: 
{ xs:string }
</ns:EIN>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="EIN" type="xs:string"/>
ns:ExternalID
Type:
xs:string, predefined, simple content
A unique identifier created and used by PayPal Giving Fund to identify a registered nonprofit charity organization. This field is only returned for charities that are registered with PayPal Giving Fund.
XML Representation Summary
<ns:ExternalID>
   
Content: 
{ xs:string }
</ns:ExternalID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ExternalID" type="xs:string"/>
ns:ListingNPContactName
Type:
xs:string, predefined, simple content
This field is for internal use only.
XML Representation Summary
<ns:ListingNPContactName>
   
Content: 
{ xs:string }
</ns:ListingNPContactName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ListingNPContactName" type="xs:string"/>
ns:ListingNPEmail
Type:
xs:string, predefined, simple content
This field is for internal use only.
XML Representation Summary
<ns:ListingNPEmail>
   
Content: 
{ xs:string }
</ns:ListingNPEmail>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ListingNPEmail" type="xs:string"/>
ns:ListingNPEmailNotifPref
Type:
xs:boolean, predefined, simple content
This flag is for internal use only.
XML Representation Summary
<ns:ListingNPEmailNotifPref>
   
Content: 
{ xs:boolean }
</ns:ListingNPEmailNotifPref>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ListingNPEmailNotifPref" type="xs:boolean"/>
ns:LogoURL
Type:
xs:anyURI, predefined, simple content
The URL to the nonprofit charity organization's logo image. The image file will be in JPG or GIF format. This logo is displayed in charitable listings in the eBay for Charity section of the View Item page. This field is returned if available for the nonprofit organization.
XML Representation Summary
<ns:LogoURL>
   
Content: 
{ xs:anyURI }
</ns:LogoURL>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LogoURL" type="xs:anyURI"/>
ns:LogoURLSelling
Type:
xs:anyURI, predefined, simple content
An alternative to the LogoURL value. This URL indicates the location of the nonprofit charity organization's logo image. The image file will be in JPG or GIF format. This URL will be used if the LogoURL value points to a broken link or if that location either contains no image or contains an image that does not meet the eBay requirements - GIF or JPG file; maximum size of 50 KB. A nonprofit charity organization's logo is displayed in the eBay for Charity section of the View Item page for a charitable listing.
XML Representation Summary
<ns:LogoURLSelling>
   
Content: 
{ xs:anyURI }
</ns:LogoURLSelling>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LogoURLSelling" type="xs:anyURI"/>
ns:Mission
Type:
xs:string, predefined, simple content
The mission statement of the nonprofit charity organization. This field will be returned if the organization's mission statement is available.

XML Representation Summary
<ns:Mission>
   
Content: 
{ xs:string }
</ns:Mission>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Mission" type="xs:string"/>
ns:Name
Type:
xs:string, predefined, simple content
The name of a nonprofit charity organization.

XML Representation Summary
<ns:Name>
   
Content: 
{ xs:string }
</ns:Name>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Name" type="xs:string"/>
ns:NonProfitAddress
Type:
ns:NonProfitAddressType, complex content
Container consisting of the address (including latitude and longitude) of a nonprofit charity organization. This container is always returned if it is set.
Component Diagram
XML Representation Summary
<ns:NonProfitAddress>
   
Content: 
ns:AddressLine1?, ns:AddressLine2?, ns:City?, ns:State?, ns:ZipCode?, ns:Latitude?, ns:Longitude?, ns:AddressType?, {any}*
</ns:NonProfitAddress>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="NonProfitAddress" type="ns:NonProfitAddressType"/>
ns:NonProfitSecondName
Type:
xs:string, predefined, simple content
An alternative name for the nonprofit charity organization. This value is used by PayPal to search for nonprofit organizations. This value is returned if set.
XML Representation Summary
<ns:NonProfitSecondName>
   
Content: 
{ xs:string }
</ns:NonProfitSecondName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="NonProfitSecondName" type="xs:string"/>
ns:NonProfitSocialAddress
Type:
ns:NonProfitSocialAddressType, complex content
Container consisting of the nonprofit charity organization's social networking site ID/handle. A NonProfitSocialAddress container will exist for each social networking site that the charity organization is associated with. Supported social networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One or more of these containers are returned if set.
Component Diagram
XML Representation Summary
<ns:NonProfitSocialAddress>
   
Content: 
ns:SocialAddressType?, ns:SocialAddressId?
</ns:NonProfitSocialAddress>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="NonProfitSocialAddress" type="ns:NonProfitSocialAddressType"/>
ns:PopularityIndex
Type:
xs:int, predefined, simple content
An integer value that indicates a nonprofit charity organization's popularity rank in comparison with other registered eBay for Charity organizations. This value is determined and managed by PayPal Giving Fund and is based on various factors. This value is always returned for nonprofit organizations registered with PayPal Giving Fund.
XML Representation Summary
<ns:PopularityIndex>
   
Content: 
{ xs:int }
</ns:PopularityIndex>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PopularityIndex" type="xs:int"/>
ns:SearchableString
Type:
xs:string, predefined, simple content
Keyword string to be used for search purposes.
XML Representation Summary
<ns:SearchableString>
   
Content: 
{ xs:string }
</ns:SearchableString>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SearchableString" type="xs:string"/>
ns:ShowMultipleDonationAmountInCheckout
Type:
xs:boolean, predefined, simple content
This field must be used with the DisplayNameInCheckout field to control the options that are visible to a buyer during checkout. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to False, a checkbox with the one dollar option will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to False, no options will be displayed during checkout.

Reserved for future use. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout, but the multiple donation amount field will be set.
XML Representation Summary
<ns:ShowMultipleDonationAmountInCheckout>
   
Content: 
{ xs:boolean }
</ns:ShowMultipleDonationAmountInCheckout>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShowMultipleDonationAmountInCheckout" type="xs:boolean"/>
ns:Status
Type:
ns:CharityStatusCodeType, simple content
This enumeration value indicates whether or not the nonprofit organization is a valid eBay for Charity organization, and is able to receive proceeds from eBay sales.
XML Representation Summary
<ns:Status>
   
Content: 
{ enumeration of xs:token }
</ns:Status>
Simple Content
Enumeration:
"Valid"
 - 
The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
"NoLongerValid"
 - 
The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the PayPal Giving Fund.
"CustomCode"
 - 
(out) Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Status" type="ns:CharityStatusCodeType"/>
{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
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.