getTeamraiserAddressBookFilters

Provides a list of event appropriate filters to be used in combination with the getTeamraiserAddressBookContacts method.

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

Client API Syntax

Client API Parameters

Common Client Parameters

See topic Common Parameters.

cons_id

Required. A unique constituent ID.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

include_past_teammates_filters

Optional. Include Past Teammates filters in the list of address book filters available

Type xsd:boolean.

Default is false.

include_returning_team_filters

Optional. Include Returing Team filters in the list of address book filters available.

Type xsd:boolean.

Default is false.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getTeamraiserAddressBookFiltersResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.teamraiser.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <filterGroup>
  <groupName>Test Group 1</groupName>
  <filter>
    <filterName>Test Filter 1</filterName>
    <filterValue>sample_value_1</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>1</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 2</filterName>
    <filterValue>sample_value_2</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>2</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 3</filterName>
    <filterValue>sample_value_3</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>3</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 4</filterName>
    <filterValue>sample_value_4</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>4</contactsCount>
  </teamName></filter>
  </filterGroup>
  <filterGroup>
  <groupName>Test Group 2</groupName>
  <filter>
    <filterName>Test Filter 1</filterName>
    <filterValue>sample_value_1</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>2</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 2</filterName>
    <filterValue>sample_value_2</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>4</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 3</filterName>
    <filterValue>sample_value_3</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>6</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 4</filterName>
    <filterValue>sample_value_4</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>8</contactsCount>
  </teamName></filter>
  </filterGroup>
  <filterGroup>
  <groupName>Test Group 3</groupName>
  <filter>
    <filterName>Test Filter 1</filterName>
    <filterValue>sample_value_1</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>3</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 2</filterName>
    <filterValue>sample_value_2</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>6</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 3</filterName>
    <filterValue>sample_value_3</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>9</contactsCount>
  </teamName></filter>
  <filter>
    <filterName>Test Filter 4</filterName>
    <filterValue>sample_value_4</filterValue>
    <teamName xsi:nil="true">
    <contactsCount>12</contactsCount>
  </teamName></filter>
  </filterGroup>
</getTeamraiserAddressBookFiltersResponse>

JSON response

JSON

{"getTeamraiserAddressBookFiltersResponse":{"filterGroup":[{"filter":[{"teamName":null,"filterValue":"sample_value_1","filterName":"Test Filter 1","contactsCount":"1"},{"teamName":null,"filterValue":"sample_value_2","filterName":"Test Filter 2","contactsCount":"2"},{"teamName":null,"filterValue":"sample_value_3","filterName":"Test Filter 3","contactsCount":"3"},{"teamName":null,"filterValue":"sample_value_4","filterName":"Test Filter 4","contactsCount":"4"}],"groupName":"Test Group 1"},{"filter":[{"teamName":null,"filterValue":"sample_value_1","filterName":"Test Filter 1","contactsCount":"2"},{"teamName":null,"filterValue":"sample_value_2","filterName":"Test Filter 2","contactsCount":"4"},{"teamName":null,"filterValue":"sample_value_3","filterName":"Test Filter 3","contactsCount":"6"},{"teamName":null,"filterValue":"sample_value_4","filterName":"Test Filter 4","contactsCount":"8"}],"groupName":"Test Group 2"},{"filter":[{"teamName":null,"filterValue":"sample_value_1","filterName":"Test Filter 1","contactsCount":"3"},{"teamName":null,"filterValue":"sample_value_2","filterName":"Test Filter 2","contactsCount":"6"},{"teamName":null,"filterValue":"sample_value_3","filterName":"Test Filter 3","contactsCount":"9"},{"teamName":null,"filterValue":"sample_value_4","filterName":"Test Filter 4","contactsCount":"12"}],"groupName":"Test Group 3"}]}}