TeamRaiser GetParticipants and Retrieving All Participants

Brian,

You can pass the string '%%%' for first_name to get a full list.

Noah Cooper:

There isn't any API method with which you could pass an fr_id and get back an event name. My suggestion would be to create your own little "API" using Convio's PageBuilder tool -- just create a PageBuilder page with the following:

]<?xml version="1.0" encoding="UTF-8"?>
<eventName>]:title]]</eventName>

Then call the page using the syntax https://secure2.convio.net/shortname/site/SPageServer?pagename=your_pagename&pgwrap=n&fr_id=1234 (swapping out your secure URL, pagename, and fr_id).

Since you're potentially going to have several search results with the same fr_id, and you don't want to call this method over and over again, I'd recommend storing a reference to the fr_id. I did something similar for another client at http://www2.jdrf.org/site/PageServer?pagename=walk_participant_search&firstname=noah&lastname=&teamname=&state=TX. If you inspect the page, you'll see there are a series of hidden "tr-meta-provider" inputs that store location information for each TeamRaiser (in this case, I'm using the getTeamraisersByInfo method to retrieve all events in a specific state, rather than retrieving them by fr_id, but the same basic idea).

Noah,

Thanks much for the solution, I am new to Convio, would you mind to tell where to access and use pageBuilder? any documentation? I have just been assigned Convio admin right. does that give me access to pageBuilder to create new page?

Noah Cooper:

There isn't any API method with which you could pass an fr_id and get back an event name. My suggestion would be to create your own little "API" using Convio's PageBuilder tool -- just create a PageBuilder page with the following:

]<?xml version="1.0" encoding="UTF-8"?>
<eventName>]:title]]</eventName>

Then call the page using the syntax https://secure2.convio.net/shortname/site/SPageServer?pagename=your_pagename&pgwrap=n&fr_id=1234 (swapping out your secure URL, pagename, and fr_id).

Since you're potentially going to have several search results with the same fr_id, and you don't want to call this method over and over again, I'd recommend storing a reference to the fr_id. I did something similar for another client at http://www2.jdrf.org/site/PageServer?pagename=walk_participant_search&firstname=noah&lastname=&teamname=&state=TX. If you inspect the page, you'll see there are a series of hidden "tr-meta-provider" inputs that store location information for each TeamRaiser (in this case, I'm using the getTeamraisersByInfo method to retrieve all events in a specific state, rather than retrieving them by fr_id, but the same basic idea).

Noah,

Thanks, it works!

Noah Cooper:

There isn't any API method with which you could pass an fr_id and get back an event name. My suggestion would be to create your own little "API" using Convio's PageBuilder tool -- just create a PageBuilder page with the following:

]<?xml version="1.0" encoding="UTF-8"?>
<eventName>]:title]]</eventName>

Then call the page using the syntax https://secure2.convio.net/shortname/site/SPageServer?pagename=your_pagename&pgwrap=n&fr_id=1234 (swapping out your secure URL, pagename, and fr_id).

Since you're potentially going to have several search results with the same fr_id, and you don't want to call this method over and over again, I'd recommend storing a reference to the fr_id. I did something similar for another client at http://www2.jdrf.org/site/PageServer?pagename=walk_participant_search&firstname=noah&lastname=&teamname=&state=TX. If you inspect the page, you'll see there are a series of hidden "tr-meta-provider" inputs that store location information for each TeamRaiser (in this case, I'm using the getTeamraisersByInfo method to retrieve all events in a specific state, rather than retrieving them by fr_id, but the same basic idea).

Turns out I was mistaken -- there is in fact a way to get an event's name (and other data) by passing fr_id using the getTeamraisersByInfo method, e.g.

https://secure2.convio.net/shortname/site/CRTeamraiserAPI?method=getTeamraisersByInfo&api_key=foo&v=1.0&list_filter_column=fr_id&list_filter_text=1234&name=%

Where 1234 is your fr_id.

Brian Mucha:

I'm trying to build a simple Team Roster for our TeamRaisers.

My initial idea was to just pull the full list of participants sorted on last name. However the getParticipants seems to require at least one character to search on, even if my site F2F_PART_FINDER_MIN_CRITERIA option is set as 0.

So then I decided it would be acceptable to have a row of links, a through z, that showed participants starting with the selected letter when clicked. However the search this API uses is 'contains', not 'starts with'. Any advice?

Here's my code so far...

<script type="text/javascript">

$(document).ready(function()

{

getRoster('a');

});

this.getRoster=function(query)

{

$("#results").html("<p>Loading...</p>");

var requestString =

'https://]]CRTeamraiserAPI?' +

'method=getParticipants' +

'&v=1.0' +

'&api_key=]' +

'&response_format=json' +

'&suppress_response_codes=true' +

'&fr_id=1260' +

'&list_sort_column=last_name' +

'&list_ascending=true' +

'&last_name=' + query;

var requestURL = "AjaxProxy?auth=]&cnv_url=" + escape(requestString);

$.getJSON(requestURL,function(data)

{

if(data.errorResponse)

{

$("#results").html("<p>(" + data.errorResponse.message + ")</p>");

} else {

$("#results").html("");

var trObject=data.getParticipantsResponse.participant;



$.each(trObject,function()

{

$("#results").append("<p class=\\'rosterentry\\'>" + this.name.first + " " + this.name.last + " - (<a href=\\"" + this.personalPageUrl + "\\">Personal Page</a>)</p>");

});

}

});

};

</script>

<p>

<a href="#" onclick="getRoster('a'); return false;">a</a> |

<a href="#" onclick="getRoster('b'); return false;">b</a> |

<a href="#" onclick="getRoster('c'); return false;">c</a> |

... |

<a href="#" onclick="getRoster('x'); return false;">x</a> |

<a href="#" onclick="getRoster('y'); return false;">y</a> |

<a href="#" onclick="getRoster('z'); return false;">z</a>

</p>

<div id="results" style="padding: 5px; margin: 10px 0 10px 0; border: 1px solid #6CA0BF; background-color: #D7E5F0;"></div>

I know this is an old thread, but has anyaone manged to make this work lately?

i'm trying to generate a list of participants for a given event . running the code from within a page in Luminate but it does not works, sending "%%%" for last_name or first_name only gives me a "(No search criteria was provided. Please enter something to search for.)" error message on the page and passing just 'a' indicates that more than 3 characters are required.


This is what I have thus far;

<script type="text/javascript">

$(document).ready(function()
{
getRoster('%%%');
});

this.getRoster=function(query)
{

$("#results").html("<p>Loading...</p>");

var requestString =
'https://secure2.convio.net/cco/site/CRTeamraiserAPI?' +
'method=getParticipants' +
'&v=1.0' +
'&api_key=XXXXXX' +
'&response_format=json' +
'&suppress_response_codes=true' +
'&fr_id=23454' +
'&list_sort_column=last_name' +
'&list_ascending=true' +
'&first_name=' + query;


var requestURL = requestString;

$.getJSON(requestURL,function(data)
{
if(data.errorResponse)
{
$("#results").html("<p>(" + data.errorResponse.message + ")</p>");
} else {

$("#results").html("");

var trObject=data.getParticipantsResponse.participant;

$.each(trObject,function()
{
$("#results").append("<p class=\\'rosterentry\\'>" + this.name.first + " " + this.name.last + " - (<a href=\\"" + this.personalPageUrl + "\\">Personal Page</a>)</p>");
});

}
});

};

</script>

<p>
<a href="#" onclick="getRoster('a'); return false;">a</a> |
<a href="#" onclick="getRoster('b'); return false;">b</a> |
<a href="#" onclick="getRoster('c'); return false;">c</a> |

... |

<a href="#" onclick="getRoster('x'); return false;">x</a> |
<a href="#" onclick="getRoster('y'); return false;">y</a> |
<a href="#" onclick="getRoster('z'); return false;">z</a>

</p>

<div id="results" style="padding: 5px; margin: 10px 0 10px 0; border: 1px solid #6CA0BF; background-color: #D7E5F0;"></div>