CRTeamraiserAPI:addGift
servlet
method
The method name
api_key
An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v
API version to invoke. Must be "1.0".
auth
Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
center_id
The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect
Specifies a URL that the method should redirect to in the event of an error.
redirect
Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format
Used to specify either XML or JSON formatting for the response.
sign_redirects
Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source
Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created.
sub_source
Further detail to save with the "source" information.
success_redirect
Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes
Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If used, it's then the job of the client to determine error states by parsing the response body.
fr_id
The TeamRaiser event ID.
first_name
First name
gift_amount
Gift amount
last_name
Last name
payment_type
The payment type
team_id
A unique team ID
billing_city
Billing information: City
billing_first_name
Billing information: First name
billing_last_name
Billing information: Last name
billing_middle_name
Billing information: Middle name
billing_state
Billing information: State
billing_street1
Billing information: Street1
billing_street2
Billing information: Street2
billing_zip
Billing information: Zip/Postal code
check_number
Check number
city
City
country
Country
credit_card_number
Credit card number
credit_card_verification_code
Credit card verification code
credit_card_exp_date_month
Credit card expiration year
credit_card_exp_date_year
Credit card expiration month
email
E-Mail address
gift_category_id
The gift category id
gift_display_name
Gift display name
gift_display_personal_page
Display gift on personal page
middle_name
Middle name
prof_suffix
Professional suffix
state
State
street1
Street1
street2
Street2
suffix
Suffix
team_gift
This should be set to 'REQUIRED' if the gift is a team gift.
title
Title
zip
Postal or Zip code
sso_auth_token
The auth token
login
servlet
method
v
api_key
user_name
password
logout
servlet
method
v
api_key
SRTeamraiserAPI:addGift
servlet
method
The method name
api_key
An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v
API version to invoke. Must be "1.0".
auth
Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call.
center_id
The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect
Specifies a URL that the method should redirect to in the event of an error.
redirect
Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format
Used to specify either XML or JSON formatting for the response.
sign_redirects
Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source
Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created.
sub_source
Further detail to save with the "source" information.
success_redirect
Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes
Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If used, it's then the job of the client to determine error states by parsing the response body.
fr_id
The TeamRaiser event ID.
first_name
First name
gift_amount
Gift amount
last_name
Last name
payment_type
The payment type
team_id
A unique team ID
billing_city
Billing information: City
billing_first_name
Billing information: First name
billing_last_name
Billing information: Last name
billing_middle_name
Billing information: Middle name
billing_state
Billing information: State
billing_street1
Billing information: Street1
billing_street2
Billing information: Street2
billing_zip
Billing information: Zip/Postal code
check_number
Check number
city
City
country
Country
credit_card_month
Credit card expiration month
credit_card_number
Credit card number
credit_card_verification_code
Credit card verification code
credit_card_year
Credit card expiration year
email
E-Mail address
gift_category_id
The gift category id
gift_display_name
Gift display name
gift_display_personal_page
Display gift on personal page
middle_name
Middle name
prof_suffix
Professional suffix
state
State
street1
Street1
street2
Street2
suffix
Suffix
team_gift
This should be set to 'REQUIRED' if the gift is a team gift.
title
Title
zip
Postal or Zip code
sso_auth_token
The auth token