Luminate Online

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=getTeamraiserAddressBookFilters &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 ] &cons_id=value &fr_id=value [ &include_past_teammates_filters=value ] [ &include_returning_team_filters=value ] [ &count_contacts=value ] [ &include_show_all_filter=value ]

Usage Notes

To count contacts in filters, include count_contacts in your request.

To include a count of the email_rpt_show_all filter, include include_show_all_filter and count_contacts in your request.

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.

include_show_all_filter

Optional. Returns a count of the email_rpt_show_all filter when used in conjunction with the count_contacts parameter.

Type xsd:boolean.

Default is false.

count_contacts

Optional. Returns a count of all contacts in filter groups.

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.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>
    </filter>
    <filter>
      <filterName>Test Filter 2</filterName>
      <filterValue>sample_value_2</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>2</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 3</filterName>
      <filterValue>sample_value_3</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>3</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 4</filterName>
      <filterValue>sample_value_4</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>4</contactsCount>
    </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>
    </filter>
    <filter>
      <filterName>Test Filter 2</filterName>
      <filterValue>sample_value_2</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>4</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 3</filterName>
      <filterValue>sample_value_3</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>6</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 4</filterName>
      <filterValue>sample_value_4</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>8</contactsCount>
    </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>
    </filter>
    <filter>
      <filterName>Test Filter 2</filterName>
      <filterValue>sample_value_2</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>6</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 3</filterName>
      <filterValue>sample_value_3</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>9</contactsCount>
    </filter>
    <filter>
      <filterName>Test Filter 4</filterName>
      <filterValue>sample_value_4</filterValue>
      <teamName xsi:nil="true"/>
      <contactsCount>12</contactsCount>
    </filter>
  </filterGroup>
</getTeamraiserAddressBookFiltersResponse>

JSON response

{"getTeamraiserAddressBookFiltersResponse":{"filterGroup":[{"groupName":"Test Group 1","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 2","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 3","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"}]}]}}

Examples

To count contacts in filter groups AND get a count of the email_rpt_show_all filter in the TeamRaiser Event with the fr_id=1010 and cons_id=1001:

http://demo-secure.convio.net/demo829/site/CRTeamraiserAPI?method=getTeamraiserAddressBookFilters&api_key=apiKey&v=1.0 &fr_id=1001&cons_id=1001003&count_contacts=true&auth=authToken&JSESSIONID=jsessionId&include_show_all_filter=true

getTeamraiserAddressBookFilters

Client API Syntax

Usage Notes

Client API Parameters

Response

Examples

Leave a Comment