getParticipationTypes

Get the participation types defined for a TeamRaiser.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRTeamraiserAPI	SRTeamraiserAPI	GET, POST	Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getParticipationTypes &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 [ &promotion_code=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=getParticipationTypes & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & fr_id =value [ & promotion_code
=value ]

Usage Notes

getParticipationTypes retrieves a list of the participation types associated with a TeamRaiser and includes detailed information about each participation type.

To get the number of current registrations by type using the getParticipationTypes method, you must first be sure that the participation type has a limit set. When a limit is set on the participation type, this method returns a property called participationTypeRegistrationLimit which will include the current registration count.

getParticipationTypes can be used in conjunction with getRegistrationDocument and processRegistration to register a participant in a TeamRaiser.

Additional documentation of each element of the response is available in the TeamRaiser XML Schema Definition.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

promotion_code

Optional. Promotion code for participation types

Type xsd:string.

Default is .

Server API Parameters

Common Server Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

promotion_code

Optional. Promotion code for participation types

Type xsd:string.

Default is .

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getParticipationTypesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.teamraiser.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <participationType>
    <name>Shark Battler</name>
    <description>A shark battler will support shark awareness by battling two great whites in hand-to-hand combat.
    </description>
    <fee>$10.00</fee>
    <rawFee>1000</rawFee>
    <id>1000</id>
    <securityCategory>0</securityCategory>
    <order>0</order>
    <active>true</active>
    <standardRegistrationAllowed>true</standardRegistrationAllowed>
    <anonymousRegistrationAllowed>true</anonymousRegistrationAllowed>
    <screenNameRegistrationAllowed>true</screenNameRegistrationAllowed>
    <taxDeductibleAmountOfFee>$5.00</taxDeductibleAmountOfFee>
    <rawTaxDeductibleAmountOfFee>500</rawTaxDeductibleAmountOfFee>
    <minimumGoal>$10.00</minimumGoal>
    <rawMinimumGoal>1000</rawMinimumGoal>
    <promoCodeRequired>false</promoCodeRequired>
    <waiver required="false">I understand that it is an incredibly bad idea for me to do this. I don't care.
    </waiver>
    <surveyQuestion>
      <questionText>Can you bring your own harpoon and wetsuit?</questionText>
      <questionId>1100</questionId>
      <questionRequired>true</questionRequired>
      <questionOrderNumber>1</questionOrderNumber>
      <questionMinResponses xsi:nil="true">
      <questionMaxResponses xsi:nil="true">
      <key>t_shirt</key>
      <categoryId>-1</categoryId>
      <surveyInstanceId>1200</surveyInstanceId>
      <questionType>YesNo</questionType>
      <hidden>false</hidden>
    </questionMaxResponses></questionMinResponses></surveyQuestion>
    <captainQuestion>
      <questionText>Are you prepared to lead your members into glory?</questionText>
      <questionId>1101</questionId>
      <questionRequired>true</questionRequired>
      <questionOrderNumber>2</questionOrderNumber>
      <questionMinResponses xsi:nil="true">
      <questionMaxResponses xsi:nil="true">
      <key>glory</key>
      <surveyInstanceId>1200</surveyInstanceId>
      <questionType>YesNo</questionType>
      <hidden>false</hidden>
      <categoryId>-1</categoryId>
    </questionMaxResponses></questionMinResponses></captainQuestion>
    <defaultMailOptIn>true</defaultMailOptIn>
    <defaultEmailOptIn>true</defaultEmailOptIn>
    <primaryRegistrationFields>
      <field required="true">firstName</field>
      <field required="true">lastName</field>
      <field required="true">email</field>
      <field required="true">firstName</field>
      <field required="true">lastName</field>
      <field required="true">email</field>
      <field>emergencyContact</field>
      <field>phoneNumber</field>
      <field>title</field>
      <field>middleName</field>
      <field>suffix</field>
      <field>professionalSuffix</field>
      <field>address</field>
      <field>phoneNumber</field>
      <field>dateOfBirth</field>
      <field>gender</field>
      <field>employerName</field>
      <field>occupation</field>
      <field>honoree</field>
    </primaryRegistrationFields>
    <secondaryRegistrationFields>
      <field required="true">firstName</field>
      <field required="true">lastName</field>
      <field>email</field>
      <field required="true">firstName</field>
      <field required="true">lastName</field>
      <field required="true">email</field>
      <field>emergencyContact</field>
      <field>phoneNumber</field>
      <field>title</field>
      <field>middleName</field>
      <field>suffix</field>
      <field>professionalSuffix</field>
      <field>address</field>
      <field>phoneNumber</field>
      <field>dateOfBirth</field>
      <field>gender</field>
      <field>employerName</field>
      <field>occupation</field>
      <field>honoree</field>
    </secondaryRegistrationFields>
    <discountCodeAvailable>false</discountCodeAvailable>
    <emailOptInText>Yes, I would like to receive email from American Health Society</emailOptInText>
    <postalMailOptInText>Yes, I would like to receive postal mail from American Health Society
    </postalMailOptInText>
  </participationType>
  <participationType>
    <name>Shark Defender</name>
    <description>A shark defender will support shark awesomeness by harpooning shark battlers, riding sharks
      around and assisting in sealion hunts and BBQs.</description>
    <fee>$0.00</fee>
    <rawFee>0</rawFee>
    <id>1001</id>
    <securityCategory>1</securityCategory>
    <order>1</order>
    <active>true</active>
    <standardRegistrationAllowed>true</standardRegistrationAllowed>
    <anonymousRegistrationAllowed>true</anonymousRegistrationAllowed>
    <screenNameRegistrationAllowed>true</screenNameRegistrationAllowed>
    <taxDeductibleAmountOfFee>$5.00</taxDeductibleAmountOfFee>
    <rawTaxDeductibleAmountOfFee>500</rawTaxDeductibleAmountOfFee>
    <minimumGoal>$100.00</minimumGoal>
    <rawMinimumGoal>10000</rawMinimumGoal>
    <promoCodeRequired>false</promoCodeRequired>
    <waiver required="true">I vow complete annhiliation of shark hunters and occasionally bringing a 6-pack to the
      BBQ.</waiver>
    <upsellId>1200</upsellId>
    <upsellId>1201</upsellId>
    <surveyQuestion>
      <questionText>Can you bring your own harpoon and wetsuit?</questionText>
      <questionId>1100</questionId>
      <questionRequired>true</questionRequired>
      <questionOrderNumber>1</questionOrderNumber>
      <questionMinResponses xsi:nil="true">
      <questionMaxResponses xsi:nil="true">
      <key>t_shirt</key>
      <categoryId>1</categoryId>
      <surveyInstanceId>1200</surveyInstanceId>
      <questionType>YesNo</questionType>
      <hidden>true</hidden>
    </questionMaxResponses></questionMinResponses></surveyQuestion>
    <defaultMailOptIn>true</defaultMailOptIn>
    <defaultEmailOptIn>true</defaultEmailOptIn>
    <participationTypeRegistrationLimit>
      <registrationLimit>1000</registrationLimit>
      <currentRegistrations>990</currentRegistrations>
      <limitReached>true</limitReached>
      <makeNewSlotsUnavailable>true</makeNewSlotsUnavailable>
      <hideNumberLeft>false</hideNumberLeft>
    </participationTypeRegistrationLimit>
  </participationType>
</getParticipationTypesResponse>

JSON response

JSON

{"getParticipationTypesResponse":{"participationType":[{"rawMinimumGoal":"1000","secondaryRegistrationFields":{"field":[{"required":"true","content":"firstName"},{"required":"true","content":"lastName"},"email",{"required":"true","content":"firstName"},{"required":"true","content":"lastName"},{"required":"true","content":"email"},"emergencyContact","phoneNumber","title","middleName","suffix","professionalSuffix","address","phoneNumber","dateOfBirth","gender","employerName","occupation","honoree"]},"rawTaxDeductibleAmountOfFee":"500","fee":"$10.00","defaultEmailOptIn":"true","description":"A
shark battler will support shark awareness by battling two great whites in hand-to-hand
combat.","anonymousRegistrationAllowed":"true","minimumGoal":"$10.00","emailOptInText":"Yes, I would like to
receive email from American Health
Society","surveyQuestion":{"surveyInstanceId":"1200","questionOrderNumber":"1","questionId":"1100","hidden":"false","questionMinResponses":null,"questionRequired":"true","questionType":"YesNo","questionText":"Can
you bring your own harpoon and
wetsuit?","questionMaxResponses":null,"key":"t_shirt","categoryId":"-1"},"discountCodeAvailable":"false","id":"1000","primaryRegistrationFields":{"field":[{"required":"true","content":"firstName"},{"required":"true","content":"lastName"},{"required":"true","content":"email"},{"required":"true","content":"firstName"},{"required":"true","content":"lastName"},{"required":"true","content":"email"},"emergencyContact","phoneNumber","title","middleName","suffix","professionalSuffix","address","phoneNumber","dateOfBirth","gender","employerName","occupation","honoree"]},"order":"0","postalMailOptInText":"Yes,
I would like to receive postal mail from American Health
Society","rawFee":"1000","active":"true","standardRegistrationAllowed":"true","captainQuestion":{"surveyInstanceId":"1200","questionOrderNumber":"2","questionId":"1101","hidden":"false","questionMinResponses":null,"questionRequired":"true","questionType":"YesNo","questionText":"Are
you prepared to lead your members into
glory?","questionMaxResponses":null,"key":"glory","categoryId":"-1"},"promoCodeRequired":"false","defaultMailOptIn":"true","taxDeductibleAmountOfFee":"$5.00","name":"Shark
Battler","securityCategory":"0","waiver":{"required":"false","content":"I understand that it is an incredibly bad
idea for me to do this. I don't
care."},"screenNameRegistrationAllowed":"true"},{"rawMinimumGoal":"10000","participationTypeRegistrationLimit":{"hideNumberLeft":"false","limitReached":"true","currentRegistrations":"990","registrationLimit":"1000","makeNewSlotsUnavailable":"true"},"rawTaxDeductibleAmountOfFee":"500","fee":"$0.00","defaultEmailOptIn":"true","rawFee":"0","description":"A
shark defender will support shark awesomeness by harpooning shark battlers, riding sharks around and assisting in
sealion hunts and
BBQs.","active":"true","standardRegistrationAllowed":"true","upsellId":["1200","1201"],"anonymousRegistrationAllowed":"true","promoCodeRequired":"false","defaultMailOptIn":"true","taxDeductibleAmountOfFee":"$5.00","minimumGoal":"$100.00","name":"Shark
Defender","surveyQuestion":{"surveyInstanceId":"1200","questionOrderNumber":"1","questionId":"1100","hidden":"true","questionMinResponses":null,"questionRequired":"true","questionType":"YesNo","questionText":"Can
you bring your own harpoon and
wetsuit?","questionMaxResponses":null,"key":"t_shirt","categoryId":"1"},"securityCategory":"1","id":"1001","waiver":{"required":"true","content":"I
vow complete annhiliation of shark hunters and occasionally bringing a 6-pack to the
BBQ."},"order":"1","screenNameRegistrationAllowed":"true"}]}}