Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetCharitiesRequestType.h
Trading_GetCharitiesRequestType.m

Overview

Searches for nonprofit charity organizations that meet the
criteria specified in the request.
It is recommended that you use at least one input filter, because this call
no longer returns all charities when made without filters.

@ingroup EBayAPIInterface

Tasks

  •   charityID

    A unique identification number assigned by eBay to registered nonprofit
    charity organizations.

         property
  •   charityName

    A name assigned to a specified nonprofit
    organization. Accepts full charity nonprofit name
    or partial name as input. For example, enter a
    CharityName of “heart” (case-insensitive) to
    return all charity nonprofits that start with
    “heart.” Use with a MatchType value of “Contains"
    to return all charity nonprofits that contain the
    string "heart.”

         property
  •   query

    Accepts a case-insensitive string used to
    find a nonprofit charity organization. Default
    behavior is to search the CharityName field. Use
    with an IncludeDescription value of true to
    include the Mission field in the search.

         property
  •   charityRegion

    Region that the nonprofit charity organization is associated
    with. A specific nonprofit charity organization may be associated
    with only one region. Meaning of input values differs depending on
    the site. See GetCharities in the API Developer’s Guide for the meaning
    of each input/output value. CharityRegion input value must be
    valid for that SiteID.

         property
  •   charityDomain

    Domain (mission area) that a nonprofit charity organization
    belongs to. Nonprofit charity organizations may belong to multiple
    mission areas. Meaning of input values differs depending on the
    site. See GetCharities in the API Developer’s Guide for the meaning
    of each input/output value. CharityDomain input value must be valid for
    that SiteID.

         property
  •   includeDescription

    Used with Query to search for charity nonprofit
    organizations. A value of true will search the Mission field as
    well as the CharityName field for a string specified in Query.

         property
  •   matchType

    Indicates the type of string matching to use when a value is submitted in
    CharityName. If no value is specified, default behavior is “StartsWith."
    Does not apply to Query.

         property
  •   featured

    Used to decide if the search is only for featured charities.
    A value of true will search for only featured charities.

         property
  •   campaignID

    Reserved for future use.

         property

Properties

campaignID

Reserved for future use.

@property (nonatomic, retain) NSNumber *campaignID

Discussion

Reserved for future use.

type : NSNumber, wrapper for primitive long

Declared In

Trading_GetCharitiesRequestType.h

charityDomain

Domain (mission area) that a nonprofit charity organization
belongs to. Nonprofit charity organizations may belong to multiple
mission areas. Meaning of input values differs depending on the
site. See GetCharities in the API Developer’s Guide for the meaning
of each input/output value. CharityDomain input value must be valid for
that SiteID.

@property (nonatomic, retain) NSNumber *charityDomain

Discussion

Domain (mission area) that a nonprofit charity organization
belongs to. Nonprofit charity organizations may belong to multiple
mission areas. Meaning of input values differs depending on the
site. See GetCharities in the API Developer’s Guide for the meaning
of each input/output value. CharityDomain input value must be valid for
that SiteID.

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetCharitiesRequestType.h

charityID

A unique identification number assigned by eBay to registered nonprofit
charity organizations.

@property (nonatomic, retain) NSString *charityID

Discussion

A unique identification number assigned by eBay to registered nonprofit
charity organizations.

type : NSString, wrapper for primitive string

Declared In

Trading_GetCharitiesRequestType.h

charityName

A name assigned to a specified nonprofit
organization. Accepts full charity nonprofit name
or partial name as input. For example, enter a
CharityName of “heart” (case-insensitive) to
return all charity nonprofits that start with
“heart.” Use with a MatchType value of “Contains"
to return all charity nonprofits that contain the
string "heart.”

@property (nonatomic, retain) NSString *charityName

Discussion

A name assigned to a specified nonprofit
organization. Accepts full charity nonprofit name
or partial name as input. For example, enter a
CharityName of “heart” (case-insensitive) to
return all charity nonprofits that start with
“heart.” Use with a MatchType value of “Contains"
to return all charity nonprofits that contain the
string "heart.”

type : NSString, wrapper for primitive string

Declared In

Trading_GetCharitiesRequestType.h

charityRegion

Region that the nonprofit charity organization is associated
with. A specific nonprofit charity organization may be associated
with only one region. Meaning of input values differs depending on
the site. See GetCharities in the API Developer’s Guide for the meaning
of each input/output value. CharityRegion input value must be
valid for that SiteID.

@property (nonatomic, retain) NSNumber *charityRegion

Discussion

Region that the nonprofit charity organization is associated
with. A specific nonprofit charity organization may be associated
with only one region. Meaning of input values differs depending on
the site. See GetCharities in the API Developer’s Guide for the meaning
of each input/output value. CharityRegion input value must be
valid for that SiteID.

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetCharitiesRequestType.h

featured

Used to decide if the search is only for featured charities.
A value of true will search for only featured charities.

@property (nonatomic, retain) NSNumber *featured

Discussion

Used to decide if the search is only for featured charities.
A value of true will search for only featured charities.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetCharitiesRequestType.h

includeDescription

Used with Query to search for charity nonprofit
organizations. A value of true will search the Mission field as
well as the CharityName field for a string specified in Query.

@property (nonatomic, retain) NSNumber *includeDescription

Discussion

Used with Query to search for charity nonprofit
organizations. A value of true will search the Mission field as
well as the CharityName field for a string specified in Query.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetCharitiesRequestType.h

matchType

Indicates the type of string matching to use when a value is submitted in
CharityName. If no value is specified, default behavior is “StartsWith."
Does not apply to Query.

@property (nonatomic, retain) NSString *matchType

Discussion

Indicates the type of string matching to use when a value is submitted in
CharityName. If no value is specified, default behavior is “StartsWith."
Does not apply to Query.

type: string constant in Trading_StringMatchCodeType.h

Declared In

Trading_GetCharitiesRequestType.h

query

Accepts a case-insensitive string used to
find a nonprofit charity organization. Default
behavior is to search the CharityName field. Use
with an IncludeDescription value of true to
include the Mission field in the search.

@property (nonatomic, retain) NSString *query

Discussion

Accepts a case-insensitive string used to
find a nonprofit charity organization. Default
behavior is to search the CharityName field. Use
with an IncludeDescription value of true to
include the Mission field in the search.

type : NSString, wrapper for primitive string

Declared In

Trading_GetCharitiesRequestType.h