getRegistration

Provides detailed registration information for a participant.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRTeamraiserAPI	None.	POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getRegistration &api_key=value &v=value [ &auth=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 [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Luminate Online web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getRegistrationResponse 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">
  <registration>
  <addonsTotal>2400</addonsTotal>
  <consId>1234567</consId>
  <date>2018-10-03T11:01:12.962-05:00</date>
  <emergencyName>Sample Emergency Name 1</emergencyName>
  <emergencyPhone>512-555-1234</emergencyPhone>
  <eventId>1001</eventId>
  <extraGift>1500</extraGift>
  <feePaid>1000</feePaid>
  <goal>15000</goal>
  <parentRegistrationId>2345</parentRegistrationId>
  <participationTypeId>3456</participationTypeId>
  <pledgeId>222333444</pledgeId>
  <privatePage>false</privatePage>
  <raceNumber>234</raceNumber>
  <registrationId>222222222</registrationId>
  <shortcutId>3333</shortcutId>
  <aTeamCaptain>false</aTeamCaptain>
  <teamId>4444</teamId>
  <tentId>5555</tentId>
  <tentmateConsId>1222222</tentmateConsId>
  <tentmateStatus>5</tentmateStatus>
  <transactionId>55555555</transactionId>
  <tentingAllowed>false</tentingAllowed>
  <flowStep>4</flowStep>
  <checkinStatus>committed</checkinStatus>
  <selfDonor>true</selfDonor>
  <teamInformation>
    <divisionName>Sample Division Name</divisionName>
    <password>Sample Password</password>
    <recruitingGoal>10</recruitingGoal>
  </teamInformation>
  <companyInformation>
    <companyId>0</companyId>
    <companyType>LOCAL</companyType>
  </companyInformation>
  <delayedSelfPledgeInformation>
    <commitment>15000</commitment>
    <amountRaised>4500</amountRaised>
    <amountOwed>10500</amountOwed>
    <intialPayment>2500</intialPayment>
  </delayedSelfPledgeInformation>
  <receiveGiftNotification>true</receiveGiftNotification>
  <previousEventParticipant>false</previousEventParticipant>
  <lastPC2Login>0</lastPC2Login>
  </registration>
</getRegistrationResponse>

JSON response

JSON

{"getRegistrationResponse":{"registration":{"date":"2018-10-03T11:01:13.023-05:00","extraGift":"1500","tentId":"5555","receiveGiftNotification":"true","selfDonor":"true","shortcutId":"3333","lastPC2Login":"0","consId":"1234567","tentmateConsId":"1222222","companyInformation":{"companyId":"0","companyType":"LOCAL"},"registrationId":"222222222","parentRegistrationId":"2345","participationTypeId":"3456","pledgeId":"222333444","eventId":"1001","goal":"15000","tentmateStatus":"5","addonsTotal":"2400","aTeamCaptain":"false","flowStep":"4","transactionId":"55555555","privatePage":"false","tentingAllowed":"false","emergencyName":"Sample Emergency Name 1","checkinStatus":"committed","raceNumber":"234","teamId":"4444","feePaid":"1000","delayedSelfPledgeInformation":{"intialPayment":"2500","amountRaised":"4500","commitment":"15000","amountOwed":"10500"},"teamInformation":{"password":"Sample Password","divisionName":"Sample Division Name","recruitingGoal":"10"},"emergencyPhone":"512-555-1234","previousEventParticipant":"false"}}}