Luminate Online

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getRegisteredTeamraisers &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 ] [ &cons_id=value ] [ &event_type=value ] [ &event_type2=value ] [ &event_type3=value ] [ &public_event_type=value ] [ &user_name=value ]

Usage Notes

This method can be called anonymously, however, if you do not call this method within the context of a logged-in user, you must specify either a valid Constituent ID as a cons_id parameter or a valid user name as a user_name parameter; otherwise the method will return an error.

If the constituent does not belong to a team, i.e. they are registered as an individual, the teamName and teamPageUrl elements will be nil. If the constituent is an event manager, the eventManageUrl element will contain their event management center url; otherwise the eventManageUrl element will be nil.

This method returns any and all TeamRaiser events for which the constituent has registered. The "status" element in the response indicates the event's status:

0 = Unpublished
1 = Accepting registrations only
2 = Accepting registrations and gifts
3 = Accepting gifts only
4 = Closed
8 = Archived
9 = Deleted

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Optional. This is the constituent ID of the user you want to see registered events for.

Type xsd:nonNegativeInteger.

event_type

Optional. The name of the Primary Event Type to limit search results to. Omit this parameter to search on all Primary Event Types. Defaults to null.

Type xsd:string.

event_type2

Optional. The name of the Event Type 2 to limit search results to. Omit this parameter to search on events with any Event Type 2. Defaults to null.

Type xsd:string.

event_type3

Optional. The name of the Event Type 3 to limit search results to. Omit this parameter to search on events with any Event Type 3. Defaults to null.

Type xsd:string.

public_event_type

Optional. The case-sensitive name of the Public Event Type to limit search results to. Omit this parameter to search on events with any Public Event Type. Defaults to null.

Type xsd:string.

user_name

Optional. This is the username of the user you want to see registered events for.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getRegisteredTeamraisersResponse 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">
  <consId>1234567</consId>
  <teamraiser>
    <id>12001</id>
    <name>Sample Event Title 1</name>
    <description>Sample Event Description 1</description>
    <event_date>2016-02-01T09:43:43.281-06:00</event_date>
    <accepting_registrations>true</accepting_registrations>
    <accepting_donations>true</accepting_donations>
    <location_name>Sample Location 1</location_name>
    <street_address>1234 Fake St.</street_address>
    <city>Austin</city>
    <state>TX</state>
    <zip>78758</zip>
    <county>Travis</county>
    <country>United States</country>
    <region>Hill Country</region>
    <area>North Austin</area>
    <mailingAddrAttn>J. Doe</mailingAddrAttn>
    <mail_street1>1234 Fake Ave.</mail_street1>
    <mail_street2>Suite 1000</mail_street2>
    <mail_city>Austin</mail_city>
    <mail_state>TX</mail_state>
    <mail_zip>78758</mail_zip>
    <status>1</status>
    <greeting_url>http://example.com/greetingUrl</greeting_url>
    <find_url>http://example.com/findTeamOrParticipantUrl</find_url>
    <donate_event_url>http://example.com/donateUrl</donate_event_url>
    <reg_indiv_url>http://example.com/registerIndividualUrl</reg_indiv_url>
    <reg_new_team_url>http://example.com/formANewTeamUrl</reg_new_team_url>
    <reg_join_team_url>http://example.com/joinTeamUrl</reg_join_team_url>
    <public_event_type_name>Central Texas</public_event_type_name>
    <ecommerce_event_url>http://example.com/eCommerceEventUrl</ecommerce_event_url>
    <customized_url>http://example.com/customizedUrl</customized_url>
    <teamName>Sample Team Name 1</teamName>
    <teamPageUrl>http://www.sampleteam.com/page1</teamPageUrl>
    <eventManageUrl>http://www.samplecenter.com/center1</eventManageUrl>
  </teamraiser>
  <teamraiser>
    <id>12002</id>
    <name>Sample Event Title 2</name>
    <description>Sample Event Description 2</description>
    <event_date>2016-02-01T09:43:43.282-06:00</event_date>
    <accepting_registrations>true</accepting_registrations>
    <accepting_donations>true</accepting_donations>
    <location_name>Sample Location 2</location_name>
    <street_address>1234 Fake St.</street_address>
    <city>Austin</city>
    <state>TX</state>
    <zip>78758</zip>
    <county>Travis</county>
    <country>United States</country>
    <region>Hill Country</region>
    <area>North Austin</area>
    <mailingAddrAttn>J. Doe</mailingAddrAttn>
    <mail_street1>1234 Fake Ave.</mail_street1>
    <mail_street2>Suite 1000</mail_street2>
    <mail_city>Austin</mail_city>
    <mail_state>TX</mail_state>
    <mail_zip>78758</mail_zip>
    <status>1</status>
    <greeting_url>http://example.com/greetingUrl</greeting_url>
    <find_url>http://example.com/findTeamOrParticipantUrl</find_url>
    <donate_event_url>http://example.com/donateUrl</donate_event_url>
    <reg_indiv_url>http://example.com/registerIndividualUrl</reg_indiv_url>
    <reg_new_team_url>http://example.com/formANewTeamUrl</reg_new_team_url>
    <reg_join_team_url>http://example.com/joinTeamUrl</reg_join_team_url>
    <public_event_type_name>Central Texas</public_event_type_name>
    <ecommerce_event_url>http://example.com/eCommerceEventUrl</ecommerce_event_url>
    <customized_url>http://example.com/customizedUrl</customized_url>
    <teamName>Sample Team Name 2</teamName>
    <teamPageUrl>http://www.sampleteam.com/page2</teamPageUrl>
    <eventManageUrl xsi:nil="true"/>
  </teamraiser>
  <teamraiser>
    <id>12003</id>
    <name>Sample Event Title 3</name>
    <description>Sample Event Description 3</description>
    <event_date>2016-02-01T09:43:43.283-06:00</event_date>
    <accepting_registrations>true</accepting_registrations>
    <accepting_donations>true</accepting_donations>
    <location_name>Sample Location 3</location_name>
    <street_address>1234 Fake St.</street_address>
    <city>Austin</city>
    <state>TX</state>
    <zip>78758</zip>
    <county>Travis</county>
    <country>United States</country>
    <region>Hill Country</region>
    <area>North Austin</area>
    <mailingAddrAttn>J. Doe</mailingAddrAttn>
    <mail_street1>1234 Fake Ave.</mail_street1>
    <mail_street2>Suite 1000</mail_street2>
    <mail_city>Austin</mail_city>
    <mail_state>TX</mail_state>
    <mail_zip>78758</mail_zip>
    <status>1</status>
    <greeting_url>http://example.com/greetingUrl</greeting_url>
    <find_url>http://example.com/findTeamOrParticipantUrl</find_url>
    <donate_event_url>http://example.com/donateUrl</donate_event_url>
    <reg_indiv_url>http://example.com/registerIndividualUrl</reg_indiv_url>
    <reg_new_team_url>http://example.com/formANewTeamUrl</reg_new_team_url>
    <reg_join_team_url>http://example.com/joinTeamUrl</reg_join_team_url>
    <public_event_type_name>Central Texas</public_event_type_name>
    <ecommerce_event_url>http://example.com/eCommerceEventUrl</ecommerce_event_url>
    <customized_url>http://example.com/customizedUrl</customized_url>
    <teamName>Sample Team Name 3</teamName>
    <teamPageUrl>http://www.sampleteam.com/page3</teamPageUrl>
    <eventManageUrl>http://www.samplecenter.com/center3</eventManageUrl>
  </teamraiser>
</getRegisteredTeamraisersResponse>

JSON response

{"getRegisteredTeamraisersResponse":{"consId":"1234567","teamraiser":[{"teamName":"Sample Team Name 1","region":"Hill Country","state":"TX","city":"Austin","id":"12001","reg_new_team_url":"http://example.com/formANewTeamUrl","mail_state":"TX","area":"North Austin","eventManageUrl":"http://www.samplecenter.com/center1","description":"Sample Event Description 1","name":"Sample Event Title 1","mail_city":"Austin","reg_indiv_url":"http://example.com/registerIndividualUrl","ecommerce_event_url":"http://example.com/eCommerceEventUrl","public_event_type_name":"Central Texas","zip":"78758","reg_join_team_url":"http://example.com/joinTeamUrl","location_name":"Sample Location 1","status":"1","customized_url":"http://example.com/customizedUrl","find_url":"http://example.com/findTeamOrParticipantUrl","country":"United States","accepting_donations":"true","donate_event_url":"http://example.com/donateUrl","greeting_url":"http://example.com/greetingUrl","teamPageUrl":"http://www.sampleteam.com/page1","county":"Travis","event_date":"2016-02-01T09:43:43.285-06:00","mail_zip":"78758","mailingAddrAttn":"J. Doe","street_address":"1234 Fake St.","accepting_registrations":"true","mail_street1":"1234 Fake Ave.","mail_street2":"Suite 1000"},{"teamName":"Sample Team Name 2","region":"Hill Country","state":"TX","city":"Austin","id":"12002","reg_new_team_url":"http://example.com/formANewTeamUrl","mail_state":"TX","area":"North Austin","eventManageUrl":null,"description":"Sample Event Description 2","name":"Sample Event Title 2","mail_city":"Austin","reg_indiv_url":"http://example.com/registerIndividualUrl","ecommerce_event_url":"http://example.com/eCommerceEventUrl","public_event_type_name":"Central Texas","zip":"78758","reg_join_team_url":"http://example.com/joinTeamUrl","location_name":"Sample Location 2","status":"1","customized_url":"http://example.com/customizedUrl","find_url":"http://example.com/findTeamOrParticipantUrl","country":"United States","accepting_donations":"true","donate_event_url":"http://example.com/donateUrl","greeting_url":"http://example.com/greetingUrl","teamPageUrl":"http://www.sampleteam.com/page2","county":"Travis","event_date":"2016-02-01T09:43:43.285-06:00","mail_zip":"78758","mailingAddrAttn":"J. Doe","street_address":"1234 Fake St.","accepting_registrations":"true","mail_street1":"1234 Fake Ave.","mail_street2":"Suite 1000"},{"teamName":"Sample Team Name 3","region":"Hill Country","state":"TX","city":"Austin","id":"12003","reg_new_team_url":"http://example.com/formANewTeamUrl","mail_state":"TX","area":"North Austin","eventManageUrl":"http://www.samplecenter.com/center3","description":"Sample Event Description 3","name":"Sample Event Title 3","mail_city":"Austin","reg_indiv_url":"http://example.com/registerIndividualUrl","ecommerce_event_url":"http://example.com/eCommerceEventUrl","public_event_type_name":"Central Texas","zip":"78758","reg_join_team_url":"http://example.com/joinTeamUrl","location_name":"Sample Location 3","status":"1","customized_url":"http://example.com/customizedUrl","find_url":"http://example.com/findTeamOrParticipantUrl","country":"United States","accepting_donations":"true","donate_event_url":"http://example.com/donateUrl","greeting_url":"http://example.com/greetingUrl","teamPageUrl":"http://www.sampleteam.com/page3","county":"Travis","event_date":"2016-02-01T09:43:43.286-06:00","mail_zip":"78758","mailingAddrAttn":"J. Doe","street_address":"1234 Fake St.","accepting_registrations":"true","mail_street1":"1234 Fake Ave.","mail_street2":"Suite 1000"}]}}

getRegisteredTeamraisers

Client API Syntax

Usage Notes

Client API Parameters

Response

Leave a Comment