Provides detailed information about a team.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRTeamraiserAPI | SRTeamraiserAPI | GET, POST | Server. |
This method returns a list of TeamRaiser teams. You can retrieve information for a single team specified in the team_id parameter, or retrieve a list of teams filtered by other parameters.
If you do not supply the team_id, you must include at least one of the following filter parameters:
Filters are conjoined using AND logic; the API returns the intersection of the filtered result sets.
Note: You must supply fr_id in order to retrieve performance data (amountRaised).
Note: Use the optional parameter include_unreturned_teams, to include unreturned teams from the previous, associated TeamRaiser. You must supply the fr_id of a TeamRaiser configured for recurring teams. Do not include any of the event_type or public_event_type filters.
This method returns data for teams associated with events that are Unpublished, Accepting Registrations Only, Accepting Registrations and Gifts, Accepting Gifts Only, or Closed. It does not return data for teams associated with Deleted or Archived events. If the associated event is not accepting registrations, the joinTeamURL element of the response document will be null. If the event is not accepting gifts, the teamDonateURL element will be null. Both elements will be null for Unpublished or Closed events.
Note: When searching on company, team, or team captain name, the search is a "contains" search, and is case insensitive. A search for first_name=jo will return participants with a First name of "Jon", "John", "Joan", etc.
To search by team captain, you must include a certain number of characters in order for the system to be able to perform the search. The default minimum characters comes from the Site Data Parameter F2F_PART_FINDER_MIN_CRITERIA. If that SDP is not set to a number, the search defaults to requiring a minimum of 3 characters. This minimum number of characters is applied to a combination of the first_name and last_name parameters.
Note: If the minimum characters is 3, then you must provide at least 3 characters total between the first_name and last_name parameters. A search for first_name=n &last_name=ng would be successful, but a search for first_name=n &last_name=n would generate an error.
Additionally, the list of Teams that is returned supports several parameters allowing finer control of the results, including additional filtering, pagination, and sorting.
Paginating the List takes two parameters: list_page_size, which specifies the number of results to be retrieved for that page. You must also provide one of the following two parameters:
Filtering the List takes two parameters:
Note: list_filter_text performs an exact match, and is case sensitive.
Sorting the List takes two parameters:
Note: You can paginate, filter, and sort the list all in one call.
See topic Common Parameters.
Optional. The end date of a date range in which to return participants who had a registration record created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.
Type xsd:dateTime.
Optional. The start date of a date range in which to return participants who had a registration record created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.
Type xsd:dateTime.
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.
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.
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.
Optional. Team Captain first name.
Type xsd:string.
Optional. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Optional. If TRUE, returns all events regardless of event status, otherwise returns only published events. Possible status values include: Unpublished = 0, Accepting Registrations Only = 1, AcceptingRegistrations and Gifts = 2, Accepting Gifts Only= 3, Closed = 4, Archived = 8, Deleted = 9.
Type xsd:boolean.
Optional. If true, returns previous teams which have not been reformed for a given Teamraiser.
Type xsd:boolean.
Default is false.
Optional. Team Captain last name.
Type xsd:string.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The database column that will be used to match the filter text (used with "list_filter_text").
Type xsd:string.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
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.
Optional. Team Captain screen name.
Type xsd:string.
Optional. The name of the team company.
Type xsd:string.
Optional. The id of the team company.
Type xsd:nonNegativeInteger.
Optional. The team division.
Type xsd:string.
Optional. A unique team ID.
Type xsd:nonNegativeInteger.
Optional. A unique team name.
Type xsd:string.
See topic Common Parameters.
Optional. The end date of a date range in which to return participants who had a registration record created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.
Type xsd:dateTime.
Optional. The start date of a date range in which to return participants who had a registration record created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.
Type xsd:dateTime.
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.
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.
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.
Optional. Team Captain first name.
Type xsd:string.
Optional. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
Optional. If TRUE, returns all events regardless of event status, otherwise returns only published events. Possible status values include: Unpublished = 0, Accepting Registrations Only = 1, AcceptingRegistrations and Gifts = 2, Accepting Gifts Only= 3, Closed = 4, Archived = 8, Deleted = 9.
Type xsd:boolean.
Optional. If true, returns previous teams which have not been reformed for a given Teamraiser.
Type xsd:boolean.
Default is false.
Optional. Team Captain last name.
Type xsd:string.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The database column that will be used to match the filter text (used with "list_filter_text").
Type xsd:string.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
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.
Optional. Team Captain screen name.
Type xsd:string.
Optional. The name of the team company.
Type xsd:string.
Optional. The id of the team company.
Type xsd:nonNegativeInteger.
Optional. The team division.
Type xsd:string.
Optional. A unique team ID.
Type xsd:nonNegativeInteger.
Optional. A unique team name.
Type xsd:string.
See topic HTTP Status Codes.
XML response
1
Sample Team Name
15850
50000
12345
1001001
Earl
Campbell
The Tyler Rose
false
1000
Blackbaud
7
South Central
false
false
12345
0
http://blackbaud.com/goto/myTeam
http://convio.com/site/TRR/ABC/General/2053821550?pg=tfind&fr_id=1000&fr_tjoin=1003
1000
Austin fun run
http://convio.com/site/TRR/ABC/General/2053821550?pg=team&fr_id=1000&team_id=1003
0
JSON response
{"getTeamSearchByInfoResponse":{
"totalNumberResults":"1","team":{
"joinTeamURL":"http://convio.com/site/TRR/ABC/General/2053821550?pg=tfind&fr_id=1000&fr_tjoin=1003",
"companyName":"Blackbaud",
"divisionName":"South Central",
"captainScreenname":"The Tyler Rose",
"isCaptainAnon":"false","numMembers":"7",
"isHonoraryTeam":"false",
"teamDonateURL":null,
"redirectShortcutURL":"http://blackbaud.com/goto/myTeam",
"EventId":"1000",
"eventName":"Austin fun run",
"id":"12345",
"captainConsId":"1001001",
"goal":"50000",
"teamEcommerceURL":null,
"amountRaised":"15850",
"captainFirstName":"Earl",
"maxTeamSize":"0",
"companyId":"1000",
"requiresPassword":"false",
"name":"Sample Team Name",
"previousTeamId":"0",
"captainLastName":"Campbell",
"originalTeamId":"12345",
"teamPageURL":"http://convio.com/site/TRR/ABC/General/2053821550?pg=team&fr_id=1000&team_id=1003"
}
}}
To perform a search for all teams with a team captain named "Jane" and the company name "Blackbaud" in any event:
https://secure2.convio.net/myorg/site/CRTeamraiserAPI?method=getTeamsByInfo&api_key=MyAPIKey&v=1.0&first_name=Jane&company_name=Blackbaud
To search the event with fr_id=1000, looking for teams with a first name containing "J", the last name containing "Doe", and to retrieve the first page of results, displaying 10 results per page:
https://secure2.convio.net/myorg/site/CRTeamraiserAPI?method=getTeamsByInfo&api_key=MyAPIKey&v=1.0&fr_id=1000&team_name=j&list_page_size=10&list_page_offset=0
Comments