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 ] [ &sso_auth_token=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

Usage Notes

This method provides detailed registration information for a participant registered under a TeamRaiser event by fetching the registration information based on the fr_id parameter. The participant consId is fetched from the current session.

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

Leave a Comment

Nickname
Comment
Enter this word: