getEventDataParameter

Provides the value of one or more TeamRaiser event data parameters (EDPs).  

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. GET, POST No.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getEventDataParameter &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value&fr_id=value &edp_name=value ] [ &edp_names=value ][ &edp_type=value ]

Usage Notes

Use this method to retrieve event setting information for a TeamRaiser event. You must use either edp_name for one event setting or edp_names for multiple event settings or an error occurs. When using edp_names, separate the values by comma.

When the requested EDP is not configured for the event, the value from the site option (SDP) is returned. If there is no SDP configured, the method returns a value of nil.

Examples of valid values for edp_name and edp_names are:

  • F2F_ACCEPT_OFFLINE_SERVER_API
  • F2F_ACCEPT_OFFLINE
  • F2F_ADMIN_NEWS_FEEDS_ENABLED
  • F2F_ALLOW_EVENT_MANAGEMENT
  • F2F_ALLOW_OFFLINE_PART_TYPES
  • F2F_ALLOW_SHOP_FOR_PREMIUMS
  • F2F_BLUEPRINT_LOCKING_ENABLED
  • F2F_BLUEPRINT_SHOW_ALL_DEBUG_MODE
  • F2F_CENTER_TAF_BOUNCE_NOTIFICATION_ENABLED
  • F2F_CENTER_TAF_PERSONALIZED_SALUTATION_ENABLED
  • F2F_CHART_DATA_API_DAYS_ALLOWED
  • F2F_COMPANY_FUNDRAISING_GOALS
  • F2F_COMPONENT_STYLING_ENABLED
  • F2F_CROSS_JVM_CACHE_ENABLED
  • F2F_CUSTOMIZED_URL_IS_PERMANENT
  • F2F_DEFAULT_STATIONERY
  • F2F_DISABLE_CLASSIC_PART_CENTER
  • F2F_DISABLE_SELF_DONATION_RECEIPTS
  • F2F_DISPLAY_LIST_DONATE_BUTTON
  • F2F_DISPLAY_LIST_ECOMMERCE_BUTTON
  • F2F_DONOR_HONOR_ROLL_BY_ALPHA
  • F2F_ECOMMERCE_ALLOW_ENABLED
  • F2F_ECOMMERCE_CREDIT_PARTICIPANT
  • F2F_ECOMMERCE_CREDIT_TEAM
  • F2F_ECOMMERCE_ENABLED
  • F2F_ECOMMERCE_PRODUCT_ID
  • F2F_ECOMMERCE_STORE_ID
  • F2F_EM_CONTACT_SEARCH_MAX_RESULTS
  • F2F_EM_SHOW_UNCONFIRMED_GIFTS_IN_HISTORY
  • F2F_ENABLE_ACHIEVEMENT_BADGES
  • F2F_ENFORCE_UNIQUE_EMAIL
  • F2F_ENFORCE_UNIQUE_NAME_AND_EMAIL
  • F2F_EVENT_CREATION_EMAIL
  • F2F_HTML_SUGGESTED_MESSAGES_ALLOW_IMAGES
  • F2F_HTML_SUGGESTED_MESSAGES_ALLOW_LINKS
  • F2F_HTML_SUGGESTED_MESSAGES_ENABLED
  • F2F_INCLUDE_UNCONFIRMED
  • F2F_MILESTONES_ENABLED
  • F2F_MILESTONES_NUM_ALLOWED
  • F2F_MULTIPLE_CAPTAINS_ENABLED
  • F2F_OFFLINE_GIFT_GIFT_AID_DESC
  • F2F_OFFLINE_GIFT_GIFT_AID
  • F2F_OFFLINE_GIFT_NOTIFICATION_DISABLED
  • F2F_OFFLINE_PMT_TYPES
  • F2F_OFFLINE_TEAM_GIFTS_ALLOW_TYPE
  • F2F_PART_CENTER_COOKIE_MAX_AGE
  • F2F_PART_CENTER_EMAIL_DAYS
  • F2F_PART_CENTER_INCLUDE_SECOND_PHOTO
  • F2F_PART_CENTER_LOGOUT_REDIRECT
  • F2F_PART_CENTER_MIN_AB_SIZE
  • F2F_PART_CENTER_OVERRIDE_ABOOK_URL
  • F2F_PART_CENTER_OVERRIDE_EMAIL_URL
  • F2F_PART_CENTER_OVERRIDE_GIFT_URL
  • F2F_PART_CENTER_OVERRIDE_PEDITOR_URL
  • F2F_PART_CENTER_OVERRIDE_PROGRESS_URL
  • F2F_PART_CENTER_OVERRIDE_SETTINGS
  • F2F_PART_CENTER_OVERRIDE_TENTING_URL
  • F2F_PART_CENTER_OVERRIDE_TPROGRESS_URL
  • F2F_PART_CENTER_OVERRIDE_URL
  • F2F_PART_CENTER_PERSONAL_PAGE_DAYS
  • F2F_PART_CENTER_PROGRESS_IMAGE_ID
  • F2F_PART_CENTER_SHARE_ACTION
  • F2F_PART_CENTER_SHARE_ID
  • F2F_PART_CENTER_SHARE_MESSAGE
  • F2F_PART_CENTER_SHARE_TITLE
  • F2F_PART_CENTER_UPDATE_GOAL_PERCENT
  • F2F_PART_CENTER_USE_YUI_STORAGE
  • F2F_PART_EDIT_REG_RESPONSES
  • F2F_PARTICIPANT_ALLOW_CARD_PROCESS
  • F2F_PARTICIPANT_EMAILS_TRACKABLE
  • F2F_PC2_PARTICIPANT_CAN_SELF_MANAGE_TEAM
  • F2F_PERSONAL_BLOGS_ENABLED
  • F2F_PERSONAL_PRECALCULATION_ENABLED
  • F2F_PRECALCULATION_ENABLED
  • F2F_PRECALCULATION_INTERVAL
  • F2F_PRECALCULATION_NAME_UPDATE_ENABLED
  • F2F_PRECALCULATION_NAME_UPDATE_INTERVAL
  • F2F_PRECALCULATION_NAME_UPDATE_TIME
  • F2F_PUBLIC_EVENT_TYPES_ENABLED
  • F2F_REASSIGN_RACE_NUMBER
  • F2F_RECENT_ACTIVITY_SIZE
  • F2F_RECRUITING_GOALS
  • F2F_REG_ANONYMOUS_CHECKBOX
  • F2F_REG_INTERACTION_SHOW_SNAPSHOT
  • F2F_REG_PUBLIC_CHECKBOX
  • F2F_RESTRICT_STATIONERY_TO_EVENT
  • F2F_RETURNING_TEAMS_AB_VISIBILITY
  • F2F_RETURNING_TEAMS_COPY_PREVIOUS_COMPANY
  • F2F_RETURNING_TEAMS_COPY_PREVIOUS_DIVISION
  • F2F_RETURNING_TEAMS_COPY_PREVIOUS_GOAL
  • F2F_RETURNING_TEAMS_ENABLED
  • F2F_RETURNING_TEAMS_KEEP_PREVIOUS_ROLES
  • F2F_RETURNING_TEAMS_REFORMER
  • F2F_RETURNING_TEAMS_USE_PREVIOUS_TEAM_PAGE
  • F2F_SCREENNAME_MAX_LENGTH
  • F2F_SHOW_GIFT_CATEGORIES_FOR_PARTICIPANT_GIFTS
  • F2F_STATUS_INCLUDE_SECONDARY_REG_FEES
  • F2F_STATUS_THERMOMETER_PROGRESS_IMAGE
  • F2F_TEAM_AB_VISIBILITY
  • F2F_TEAM_MILESTONES_ENABLED
  • F2F_TEAM_MILESTONES_NUM_ALLOWED
  • F2F_TEAM_ROSTER_MAX_INCLUDE_AMOUNT_SIZE
  • F2F_TEAMRAISER_LIST_COMPONENT_MAX_SIZE
  • F2F_UPDATE_CONSTITUENT_FROM_SECONDARY_REGISTRANT
  • F2F_UPLOAD_REG_ALLOW_TRANSACTIONS
  • F2F_USER_CAN_CHOOSE_LAYOUT
  • F2F_USER_CAN_CHOOSE_STATUS_IND
  • F2F_USER_CAN_CHOOSE_STYLE
  • F2F_USER_RICH_TEXT_PAGES_ALLOW_IMAGES
  • F2F_USER_RICH_TEXT_PAGES_ALLOW_LINKS
  • F2F_USER_RICH_TEXT_PAGES_ENABLED

Valid values edp_type are:

  • Boolean
  • Integer
  • String

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

edp_name

Required. The name of the requested Event Data Parameter (EDP).

edp_names

Optional. The comma-separated names of the requested Event Data Parameters (EDP).

edp_type

Optional. This is the way the EDP will be represented. Values are: string, integer, and boolean

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getEventDataParameterResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <stringValue>Sample Value</stringValue>
</getEventDataParameterResponse>
JSON response
{"getEventDataParameterResponse":{"stringValue":"Sample Value"}}

        

Leave a Comment

Nickname
Comment
Enter this word: