Usage Notes

This method accepts a list containing one or more TeamRaiser Event data blocks, up to a system-configurable maximum of 1000 Events, and asynchronously adds them to the Luminate Online database.

Input data is passed url-encoded as the value of the add_teamraiser parameter in the following format:

  <addTeamraiserRequest xmlns="http://convio.com/crm/v1.0">
  <baseFrId>1010</baseFrId>
  <createAsChild>true</createAsChild>
  <createAsBlueprint>false</createAsBlueprint>
  <teamraiserCreate>
    <eventStatus>2</eventStatus>
    <eventDateDay>3</eventDateDay>
    <eventDateMonth>11</eventDateMonth>
    <eventDateYear>2011</eventDateYear>
    <eventTitle>Mathathon 78705</eventTitle>
    <eventUserTitle>Mathathon Austin Texas</eventUserTitle>
    <eventLocalOfficeAttn>Chris</eventLocalOfficeAttn>
    <eventLocalOfficeStreet1>123 Main St</eventLocalOfficeStreet1>
    <eventLocalOfficeStreet2>Unit 194</eventLocalOfficeStreet2>
    <eventLocalOfficeCity>Austin</eventLocalOfficeCity>
    <eventLocalOfficeState>TX</eventLocalOfficeState>
    <eventLocalOfficeZip>78726</eventLocalOfficeZip>
    <fundraisingCampaign>1021</fundraisingCampaign>
    <fundraisingForm>4</fundraisingForm>
    <eventCategory>General</eventCategory>
    <eventInterest>Math</eventInterest>
    <prevFrId>1000</prevFrId>
    <classificationId>Generic</classificationId>
    <classificationId2>ABC123</classificationId2>
    <fiscalYear>2010</fiscalYear>
    <locale>en_US</locale>
    <publicEventType>EventType3</publicEventType>
    <eventDate>March 11th</eventDate>
    <eventLocation>Cowboys Stadium</eventLocation>
    <eventLocationStreet1>One Legends Way</eventLocationStreet1>
    <eventLocationCity>Arlington</eventLocationCity>
    <eventLocationState>TX</eventLocationState>
    <eventLocationZip>76011</eventLocationZip>
    <eventLocationCountry>United States</eventLocationCountry>
    <eventLocationCounty>Dallas County</eventLocationCounty>
    <eventLocationRegion>North Texas</eventLocationRegion>
    <eventLocationArea>Dallas Metro</eventLocationArea>
    <eventSchedule>Arrive at 11. The math begins at noon, prizes at 3pm.</eventSchedule>
    <mapLink>www.maps.google.com/cowboysstadium</mapLink>
    <coordinatorEmail>jjones@cowboys.com</coordinatorEmail>
    <coordinatorName>Jerry Jones</coordinatorName>
    <coordinatorPhone>(512) 555-5555</coordinatorPhone>
    <sponsor1>Pepsi</sponsor1>
    <sponsor2>Frito Lay</sponsor2>
    <sponsor3>NFL</sponsor3>
    <sponsor4>Ford</sponsor4>
    <sponsor5>ESPN</sponsor5>
  </teamraiserCreate>
  <teamraiserCreate>
    <eventDateDay>3</eventDateDay>
    <eventDateMonth>11</eventDateMonth>
    <eventDateYear>2011</eventDateYear>
    <eventTitle>Mathathon 55901</eventTitle>
    <eventUserTitle>Mathathon Rochester</eventUserTitle>
  </teamraiserCreate>
  <teamraiserCreate>
    <eventDateDay>3</eventDateDay>
    <eventDateMonth>11</eventDateMonth>
    <eventDateYear>2011</eventDateYear>
    <eventTitle>Mathathon 77047</eventTitle>
    <eventUserTitle>Mathathon Houston</eventUserTitle>
  </teamraiserCreate>
</addTeamraiserRequest>
  

Within the <addTeamraiserRequest> structure, the <baseFrId> is required. It specifies a blueprint event that will be used for all events added by the call. This event will be copied and all of its properties will be updated by the specified properties in each <teamRaiserCreate> element. The <createAsChild> and <createAsBlueprint> elements are optional, and default false. Their behavior is described in the following table:

The <addTeamraiserRequest> also contains a collection of one or more <teamraiserCreate> elements. Each specifies the TeamRaiser parameters that will be used to build the event. In each <teamraiserCreate> block, you must specify valid values for <eventDateDay>, <eventDateMonth>, <eventDateYear>, and <eventTitle> elements, and the value of <eventTitle> must be unique. All other elements are optional.

The elements of the <TeamRaiserCreate> structure are described as follows:

eventStatus

The status of the event: Unpublished = 0 (default), Accepting Registrations Only = 1, Accepting Registrations and Gifts = 2, Accepting Gifts Only = 3, Closed = 4, Archived = 8, Deleted = 9

eventTitle

The internal name of the TeamRaiser. It must be unique and is used for matching to update existing TeamRaisers.

eventUserTitle

The public title of the TeamRaiser. Also used for page customization as the 'Event Title:' field.

eventDate

The date or dates of the event in any format. Used for page customization as the 'Event Date/Time:' field, but not stored in the event record.

eventDateMonth

The month when the event occurs in numeric (MM) format. Used to set the 'Event Date:' field.

eventDateDay

The day of the month when the event occurs in numeric (DD) format. Used to set the 'Event Date:' field.

eventDateYear

The year when the event occurs in numeric (YYYY) format. Used to set the 'Event Date:' field.

eventLocation

The location of the event. Used to set the 'Location Name:' field of the event record. Also used for page customization as the 'Event Location:' field.

eventLocationStreet1

The street address of the event. Used to set the 'Street Address:' field of the event record.

eventLocationCity

The city where the event takes place. Used to set the 'City:' field of the event record. Also used for page customization as the 'Event City:' field.

eventLocationState

The state where the event takes place. Used to set the 'State:' field of the event record. Also used for page customization as the 'Event State:' field.

eventLocationZip

The ZIP code of the location where the event takes place. Used to set the 'ZIP Code:' field of the event record.

eventLocationCountry

The country of the location where the event takes place.

eventLocationCounty

The county of the location where the event takes place.

eventLocationRegion

The region of the location where the event takes place.

eventLocationArea

The area of the location where the event takes place.

eventLocalOfficeAttn

Indicates to whom mail to the local office should be addressed.

eventLocalOfficeStreet1

First street line of the local office mailing address.

eventLocalOfficeStreet2

Second street line of the local office mailing address.

eventLocalOfficeCity

City for the local office mailing address.

eventLocalOfficeState

State for the local office mailing address.

eventLocalOfficeZip

Zip code for the local office mailing address.

eventSchedule

The schedule of the TeamRaiser. Used in the page customization as the 'Event Schedule:' field.

fundraisingCampaign

A fundraising donation campaign to associate with the event.

fundraisingForm

A fundraising donation form to associate with the event. If you specify a Donations2 campaign, you must also specify a donation form. A Donation Campaign must be specified to update the donation form.

fundraisingGoal

The financial goal for the event.

eventCategory

The security category of the event.

eventInterest

An interest category to associate with the event.

mapLink

A web address (URL) of a map to the TeamRaiser. Used in the page customization as the 'Link to Event Directions:' field.

coordinatorName

The name of the TeamRaiser coordinator. Used in the page customization as the 'Event Coordinator Name:' field.

coordinatorPhone

The phone number of the TeamRaiser coordinator. Used in the page customization as the 'Event Coordinator Phone:' field.

coordinatorEmail

The email address of the TeamRaiser coordinator. Used in the page customization as the 'Event Coordinator Email:' field.

sponsor1

The first name or image filename for a sponsor of the TeamRaiser. Used in the page customization as the 'Sponsor name or image filename (1):' field.

sponsor2

The second name or image filename for a sponsor of the TeamRaiser. Used in the page customization as the 'Sponsor name or image filename (2):' field.

sponsor3

The third name or image filename for a sponsor of the TeamRaiser. Used in the page customization as the 'Sponsor name or image filename (3):' field.

sponsor4

The fourth name or image filename for a sponsor of the TeamRaiser. Used in the page customization as the 'Sponsor name or image filename (4):' field.

sponsor5

The fifth name or image filename for a sponsor of the TeamRaiser. Used in the page customization as the 'Sponsor name or image filename (5):' field.

prevFrId

The id or name of the old TeamRaiser event we wish to associate this new TeamRaiser with.

classificationId

The ID or the name of the type for this TeamRaiser, also called the Primary Event Type. (Note that this value may be blank.)

classificationId2

A second name of the type for this TeamRaiser. (Note that this value may be blank, Name only no ID will be accepted.)

fiscalYear

The fiscal year for this TeamRaiser.

locale

The locale of this TeamRaiser event.

publicEventType

The ID or name of the public event type for this TeamRaiser. (Note that this value may be blank.)

If the call is successful, it returns a unique job ID for the batch.

Prerequisites

API Administrator accounts that access this API must be assigned TeamRaiser API User permission under the TeamRaiser Management permission type.

This API requires that the TeamRaiser Blueprinting feature be enabled for your site.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

add_teamraiser

Required. XML document specifying the TeamRaiser events to add.

Type crm:addTeamraiserList.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

add_teamraiser

Required. XML document specifying the TeamRaiser events to add.

Type crm:addTeamraiserList.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<addTeamraiserResponse 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">
  <jobId>1451426381692</jobId>
</addTeamraiserResponse>


        

{"addTeamraiserResponse":{"jobId":"1454341419996"}}