getRegistrationDocument

Gets a template document for registering 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=getRegistrationDocument &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 &participation_id=value [ &include_username_element=value ] [ &secondary_participation_id=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=getRegistrationDocument & 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 & participation_id =value [ & include_username_element =value ] [ & secondary_participation_id =value ]

Usage Notes

getRegistrationDocument retrieves an XML document that can be used as a template to register a participant of a TeamRaiser with the processRegistration method.

The registration document varies depending on the TeamRaiser and participation type. A list of participation types for a TeamRaiser can be retrieved with the getParticipationTypes method.

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

2019 Update: This method's response was updated to include the previousTeamId field if returning teams are permitted.

Note: If the selected event and participation type combination is not currently accepting registrations, this method returns an error.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

participation_id

Required. The TeamRaiser participation type ID.

Type xsd:nonNegativeInteger.

include_username_element

Optional. Determines whether or not the username element is included in the registration document returned. This can be used in conjunction with match_by_username.

Type xsd:boolean.

Default is false.

secondary_participation_id

Optional. A comma-separated list of secondary TeamRaiser participation type IDs.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

participation_id

Required. The TeamRaiser participation type ID.

Type xsd:nonNegativeInteger.

include_username_element

Optional. Determines whether or not the username element is included in the registration document returned. This can be used in conjunction with match_by_username.

Type xsd:boolean.

Default is false.

secondary_participation_id

Optional. A comma-separated list of secondary TeamRaiser participation type IDs.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<processRegistrationRequest 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">
  <eventId>1000</eventId>
  <teamId xsi:nil="true"/>
  <previousTeamId xsi:nil="true"/>
  <teamName xsi:nil="true"/>
  <teamGoal xsi:nil="true"/>
  <teamMembershipGoal xsi:nil="true"/>
  <teamPassword xsi:nil="true"/>
  <teamDivision xsi:nil="true"/>
  <companyId xsi:nil="true"/>
  <companyName xsi:nil="true"/>
  <paymentType xsi:nil="true"/>
  <recordOnly xsi:nil="true"/>
  <checkNumber xsi:nil="true"/>
  <billingTitle xsi:nil="true"/>
  <billingFirstName xsi:nil="true"/>
  <billingMiddleName xsi:nil="true"/>
  <billingLastName xsi:nil="true"/>
  <billingSuffix xsi:nil="true"/>
  <billingEmail xsi:nil="true"/>
  <billingStreet1 xsi:nil="true"/>
  <billingStreet2 xsi:nil="true"/>
  <billingStreet3 xsi:nil="true"/>
  <billingCity xsi:nil="true"/>
  <billingState xsi:nil="true"/>
  <billingCounty xsi:nil="true"/>
  <billingZip xsi:nil="true"/>
  <billingCountry xsi:nil="true"/>
  <creditCardType xsi:nil="true"/>
  <creditCardNumber xsi:nil="true"/>
  <creditCardExpMonth xsi:nil="true"/>
  <creditCardExpYear xsi:nil="true"/>
  <creditCardVerificationCode xsi:nil="true"/>
  <transactionDate xsi:nil="true"/>
  <batchId xsi:nil="true"/>
  <primaryRegistration>
    <partTypeId>1100</partTypeId>
    <consId xsi:nil="true"/>
    <memberId xsi:nil="true"/>
    <username xsi:nil="true"/>
    <promoCode xsi:nil="true"/>
    <discountCode xsi:nil="true"/>
    <fundraisingGoal xsi:nil="true"/>
    <acceptWaiver xsi:nil="true"/>
    <email required="true"/>
    <title xsi:nil="true"/>
    <firstName required="true"/>
    <middleName xsi:nil="true"/>
    <lastName required="true"/>
    <suffix xsi:nil="true"/>
    <professionalSuffix xsi:nil="true"/>
    <street1 xsi:nil="true"/>
    <street2 xsi:nil="true"/>
    <street3 xsi:nil="true"/>
    <city xsi:nil="true"/>
    <stateProv xsi:nil="true"/>
    <county xsi:nil="true"/>
    <postalCode xsi:nil="true"/>
    <country xsi:nil="true"/>
    <phoneNumber xsi:nil="true"/>
    <dateOfBirth xsi:nil="true"/>
    <gender xsi:nil="true"/>
    <employerName xsi:nil="true"/>
    <occupation xsi:nil="true"/>
    <anonymous xsi:nil="true"/>
    <screenName xsi:nil="true"/>
    <question>
      <id>1010</id>
      <type>PARTICIPATION_TYPE</type>
      <response xsi:nil="true"/>
      <key>T_SHIRT_SIZE</key>
      <hidden>false</hidden>
      <questionRequired>true</questionRequired>
    </question>
    <upsell>
      <id>1015</id>
      <optionId xsi:nil="true"/>
      <purchase>false</purchase>
    </upsell>
    <registrationFee xsi:nil="true"/>
    <additionalGift>
      <amount xsi:nil="true"/>
      <isPublic>true</isPublic>
      <isAnonymous>false</isAnonymous>
    </additionalGift>
    <emailOptIn>true</emailOptIn>
    <mailOptIn>false</mailOptIn>
    <emergencyContactName xsi:nil="true"/>
    <emergencyContactPhoneNumber xsi:nil="true"/>
    <honoreeTitle xsi:nil="true"/>
    <honoreeFirstName xsi:nil="true"/>
    <honoreeMiddleName xsi:nil="true"/>
    <honoreeLastName xsi:nil="true"/>
    <honoreeEmail xsi:nil="true"/>
    <honoreeStreet1 xsi:nil="true"/>
    <honoreeStreet2 xsi:nil="true"/>
    <honoreeStreet3 xsi:nil="true"/>
    <honoreeCity xsi:nil="true"/>
    <honoreeStateProv xsi:nil="true"/>
    <honoreeCounty xsi:nil="true"/>
    <honoreePostalCode xsi:nil="true"/>
    <honoreeCountry xsi:nil="true"/>
    <honoreeRelationship xsi:nil="true"/>
    <honoreeDeceased xsi:nil="true"/>
    <giftNotification xsi:nil="true"/>
    <emailFormat xsi:nil="true"/>
    <registrationDate xsi:nil="true"/>
    <checkInStatus xsi:nil="true"/>
    <flowStep xsi:nil="true"/>
  </primaryRegistration>
  <secondaryRegistration>
    <partTypeId>1100</partTypeId>
    <consId xsi:nil="true"/>
    <memberId xsi:nil="true"/>
    <username xsi:nil="true"/>
    <promoCode xsi:nil="true"/>
    <discountCode xsi:nil="true"/>
    <fundraisingGoal xsi:nil="true"/>
    <acceptWaiver xsi:nil="true"/>
    <email required="true"/>
    <title xsi:nil="true"/>
    <firstName required="true"/>
    <middleName xsi:nil="true"/>
    <lastName required="true"/>
    <suffix xsi:nil="true"/>
    <professionalSuffix xsi:nil="true"/>
    <street1 xsi:nil="true"/>
    <street2 xsi:nil="true"/>
    <street3 xsi:nil="true"/>
    <city xsi:nil="true"/>
    <stateProv xsi:nil="true"/>
    <county xsi:nil="true"/>
    <postalCode xsi:nil="true"/>
    <country xsi:nil="true"/>
    <phoneNumber xsi:nil="true"/>
    <dateOfBirth xsi:nil="true"/>
    <gender xsi:nil="true"/>
    <employerName xsi:nil="true"/>
    <occupation xsi:nil="true"/>
    <anonymous xsi:nil="true"/>
    <screenName xsi:nil="true"/>
    <question>
      <id>1010</id>
      <type>EVENT</type>
      <response xsi:nil="true"/>
      <key>Turned_In_Permission_Slip</key>
      <hidden>true</hidden>
      <questionRequired>true</questionRequired>
    </question>
    <upsell>
      <id>1015</id>
      <optionId xsi:nil="true"/>
      <purchase>true</purchase>
    </upsell>
    <registrationFee xsi:nil="true"/>
    <relationship xsi:nil="true"/>
  </secondaryRegistration>
</processRegistrationRequest>

JSON response

{"processRegistrationRequest":{"teamName":null,"teamMembershipGoal":null,"creditCardExpMonth":null,"companyName":null,"creditCardExpYear":null,"creditCardType":null,"creditCardVerificationCode":null,"teamPassword":null,"batchId":null,"paymentType":null,"teamGoal":null,"billingEmail":null,"recordOnly":null,"billingFirstName":null,"billingCountry":null,"billingTitle":null,"secondaryRegistration":{"lastName":{"required":"true"},"country":null,"occupation":null,"street3":null,"gender":null,"city":null,"postalCode":null,"professionalSuffix":null,"county":null,"employerName":null,"screenName":null,"title":null,"suffix":null,"consId":null,"partTypeId":"1100","promoCode":null,"street1":null,"street2":null,"relationship":null,"email":{"required":"true"},"memberId":null,"question":{"hidden":"true","response":null,"id":"1010","questionRequired":"true","type":"EVENT","key":"Turned_In_Permission_Slip"},"registrationFee":null,"dateOfBirth":null,"upsell":{"purchase":"true","optionId":null,"id":"1015"},"stateProv":null,"firstName":{"required":"true"},"phoneNumber":null,"discountCode":null,"acceptWaiver":null,"fundraisingGoal":null,"anonymous":null,"middleName":null,"username":null},"billingSuffix":null,"billingZip":null,"eventId":"1000","teamDivision":null,"checkNumber":null,"billingStreet3":null,"billingStreet2":null,"billingState":null,"billingStreet1":null,"transactionDate":null,"companyId":null,"billingLastName":null,"creditCardNumber":null,"primaryRegistration":{"country":null,"occupation":null,"honoreeMiddleName":null,"postalCode":null,"county":null,"giftNotification":null,"screenName":null,"suffix":null,"honoreePostalCode":null,"consId":null,"partTypeId":"1100","registrationDate":null,"additionalGift":{"amount":null,"isAnonymous":"false","isPublic":"true"},"emailFormat":null,"memberId":null,"honoreeStreet1":null,"honoreeStreet2":null,"honoreeStreet3":null,"honoreeLastName":null,"honoreeRelationship":null,"stateProv":null,"firstName":{"required":"true"},"honoreeEmail":null,"phoneNumber":null,"fundraisingGoal":null,"honoreeTitle":null,"lastName":{"required":"true"},"street3":null,"gender":null,"city":null,"professionalSuffix":null,"employerName":null,"emailOptIn":"true","title":null,"emergencyContactPhoneNumber":null,"honoreeCity":null,"promoCode":null,"street1":null,"honoreeDeceased":null,"street2":null,"honoreeStateProv":null,"email":{"required":"true"},"honoreeFirstName":null,"honoreeCounty":null,"question":{"hidden":"false","response":null,"id":"1010","questionRequired":"true","type":"PARTICIPATION_TYPE","key":"T_SHIRT_SIZE"},"registrationFee":null,"emergencyContactName":null,"dateOfBirth":null,"upsell":{"purchase":"false","optionId":null,"id":"1015"},"flowStep":null,"honoreeCountry":null,"discountCode":null,"acceptWaiver":null,"checkInStatus":null,"anonymous":null,"middleName":null,"mailOptIn":"false","username":null},"teamId":null,"previousTeamId":null,"billingMiddleName":null,"billingCounty":null,"billingCity":null}}

Luminate Online

getRegistrationDocument

Client API Syntax

Server API Syntax

Usage Notes

Client API Parameters

Server API Parameters

Response

Leave a Comment