getCampaignByNameData

Provides a TeamRaiser event by name.

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=getCampaignByNameData &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 ] &name=value

Client API Parameters

Common Client Parameters

See topic Common Parameters.

name

Required. The name of the TeamRaiser event.

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">
  <teamraiser>
    <id>12001</id>
    <name>Sample Event Title 1</name>
    <description>Sample Event Description 1</description>
    <event_date>2016-02-01T09:43:42.966-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>
  </teamraiser>
</getRegisteredTeamraisersResponse>

        
JSON response
{"getRegisteredTeamraisersResponse":{"teamraiser":{"region":"Hill Country","state":"TX","city":"Austin","id":"12001","reg_new_team_url":"http://example.com/formANewTeamUrl","mail_state":"TX","area":"North Austin","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","county":"Travis","event_date":"2016-02-01T09:43:42.968-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"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: