Get the participation types defined for a TeamRaiser.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRTeamraiserAPI | SRTeamraiserAPI | GET, POST | Server. |
getParticipationTypes retrieves a list of the participation types associated with a TeamRaiser and includes detailed information about each participation type.
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.
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Optional. Promotion code for participation types
Type xsd:string.
Default is .
See topic Common Parameters.
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Optional. Promotion code for participation types
Type xsd:string.
Default is .
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.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>
</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>
</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>
</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
{"getParticipationTypesResponse":{"participationType":[{"rawTaxDeductibleAmountOfFee":"500","surveyQuestion":{"questionMaxResponses":null,"questionMinResponses":null,"questionRequired":"true","questionId":"1100","hidden":"false","categoryId":"-1","questionText":"Can you bring your own harpoon and wetsuit?","questionOrderNumber":"1","questionType":"YesNo","surveyInstanceId":"1200","key":"t_shirt"},"defaultEmailOptIn":"true","waiver":{"content":"I understand that it is an incredibly bad idea for me to do this. I don't care.","required":"false"},"standardRegistrationAllowed":"true","secondaryRegistrationFields":{"field":[{"content":"firstName","required":"true"},{"content":"lastName","required":"true"},"email",{"content":"firstName","required":"true"},{"content":"lastName","required":"true"},{"content":"email","required":"true"},"emergencyContact","phoneNumber","title","middleName","suffix","professionalSuffix","address","phoneNumber","dateOfBirth","gender","employerName","occupation","honoree"]},"securityCategory":"0","id":"1000","order":"0","taxDeductibleAmountOfFee":"$5.00","description":"A shark battler will support shark awareness by battling two great whites in hand-to-hand combat.","name":"Shark Battler","minimumGoal":"$10.00","captainQuestion":{"questionMaxResponses":null,"questionMinResponses":null,"questionRequired":"true","questionId":"1101","hidden":"false","categoryId":"-1","questionText":"Are you prepared to lead your members into glory?","questionOrderNumber":"2","questionType":"YesNo","surveyInstanceId":"1200","key":"glory"},"primaryRegistrationFields":{"field":[{"content":"firstName","required":"true"},{"content":"lastName","required":"true"},{"content":"email","required":"true"},{"content":"firstName","required":"true"},{"content":"lastName","required":"true"},{"content":"email","required":"true"},"emergencyContact","phoneNumber","title","middleName","suffix","professionalSuffix","address","phoneNumber","dateOfBirth","gender","employerName","occupation","honoree"]},"discountCodeAvailable":"false","rawFee":"1000","postalMailOptInText":"Yes, I would like to receive postal mail from American Health Society","rawMinimumGoal":"1000","fee":"$10.00","anonymousRegistrationAllowed":"true","defaultMailOptIn":"true","screenNameRegistrationAllowed":"true","active":"true","promoCodeRequired":"false","emailOptInText":"Yes, I would like to receive email from American Health Society"},{"rawTaxDeductibleAmountOfFee":"500","defaultEmailOptIn":"true","surveyQuestion":{"questionMaxResponses":null,"questionMinResponses":null,"questionRequired":"true","questionId":"1100","hidden":"true","categoryId":"1","questionText":"Can you bring your own harpoon and wetsuit?","questionOrderNumber":"1","questionType":"YesNo","surveyInstanceId":"1200","key":"t_shirt"},"participationTypeRegistrationLimit":{"registrationLimit":"1000","hideNumberLeft":"false","limitReached":"true","makeNewSlotsUnavailable":"true","currentRegistrations":"990"},"waiver":{"content":"I vow complete annhiliation of shark hunters and occasionally bringing a 6-pack to the BBQ.","required":"true"},"standardRegistrationAllowed":"true","rawFee":"0","upsellId":["1200","1201"],"rawMinimumGoal":"10000","securityCategory":"1","fee":"$0.00","id":"1001","anonymousRegistrationAllowed":"true","defaultMailOptIn":"true","order":"1","screenNameRegistrationAllowed":"true","description":"A shark defender will support shark awesomeness by harpooning shark battlers, riding sharks around and assisting in sealion hunts and BBQs.","taxDeductibleAmountOfFee":"$5.00","name":"Shark Defender","active":"true","minimumGoal":"$100.00","promoCodeRequired":"false"}]}}
Comments