getTeamraiserAddressBookContacts

Provides a list of AddressBook contacts with additional Teamraiser specific information.

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

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getTeamraiserAddressBookContacts &api_key=value &v=value [ &auth=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 ] &fr_id=value [ &list_ascending=value ] [ &list_category_id=value ] [ &list_filter_column=value ] [ &list_filter_text=value ] [ &list_page_offset=value ] [ &list_page_size=value ] [ &list_record_offset=value ] [ &list_sort_column=value ] [ &skip_groups=value ] [ &tr_ab_filter=email_rpt_show_all | email_rpt_show_never_emailed | email_rpt_show_donors | email_rpt_show_unthanked_donors | email_rpt_show_nondonors | email_rpt_show_nondonors_followup | email_rpt_show_lybunt_donors | email_rpt_show_ly_donors | email_rpt_show_teammates | email_rpt_show_nonteammates | email_rpt_show_lybunt_teammates | email_rpt_show_ly_unreg_teammates | email_rpt_show_company_coordinator_captains | email_rpt_show_company_coordinator_participants ] [ &auth=value ] [ &sso_auth_token=value ]

Usage Notes

To combine contacts which meet different filter criteria in the response, concatenate the filter terms passed to the tr_ab_filter parameter in a list separated by semi-colons. In addition to the listed filter types, you can also retrieve contacts who are members of a specific address book group by including the filter type email_rpt_group_ suffixed by the numeric ID of the address book group.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

list_ascending

Optional. Whether the list should be sorted in ascending order.

Type xsd:boolean.

Default is true.

list_category_id

Optional. Security Category filter.

Type xsd:integer.

list_filter_column

Optional. The database column that will be used to match the filter text (used with "list_filter_text").

Type xsd:string.

list_filter_text

Optional. The text that will be used to filter results.

Type xsd:string.

list_page_offset

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.

list_page_size

Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").

Type xsd:integer.

Default is 25.

list_record_offset

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.

list_sort_column

Optional. The column to sort with (used with "list_ascending").

Type xsd:string.

skip_groups

Optional. Skips the retrieval of groups per contact if set to TRUE.

Type xsd:boolean.

Default is false.

tr_ab_filter

Optional. Filters address book entries by the given criteria.

Type xsd:string.

Default is email_rpt_show_all.

Options are:

email_rpt_show_all
email_rpt_show_never_emailed
email_rpt_show_donors
email_rpt_show_unthanked_donors
email_rpt_show_nondonors
email_rpt_show_nondonors_followup
email_rpt_show_lybunt_donors
email_rpt_show_ly_donors
email_rpt_show_teammates
email_rpt_show_nonteammates
email_rpt_show_lybunt_teammates
email_rpt_show_ly_unreg_teammates
email_rpt_show_company_coordinator_captains
email_rpt_show_company_coordinator_participants

auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getTeamraiserAddressBookContactsResponse xmlns="http://convio.com/crm/v1.0">
    <totalNumberResults>3</totalNumberResults>
    <addressBookContact>
        <id>101</id>
        <firstName>Sam</firstName>
        <lastName>Ple1</lastName>
        <email>sample1@example.com</email>
        <street1>1234 Some St.</street1>
        <street2>#42</street2>
        <street3></street3>
        <city>Austin</city>
        <county>Travis</county>
        <state>TX</state>
        <zip>78758</zip>
        <phone>(512) 555 1234</phone>
        <country>USA</country>
        <amountRaised>14077</amountRaised>
        <previousAmountRaised>8848</previousAmountRaised>
        <messagesSent>5</messagesSent>
        <messagesOpened>3</messagesOpened>
        <clickThroughs>1</clickThroughs>
        <acknowledged xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </addressBookContact>
    <addressBookContact>
        <id>102</id>
        <firstName>Sam</firstName>
        <lastName>Ple2</lastName>
        <email>sample2@example.com</email>
        <street1>1234 Some St.</street1>
        <street2>#42</street2>
        <street3></street3>
        <city>Austin</city>
        <county>Travis</county>
        <state>TX</state>
        <zip>78758</zip>
        <phone>(512) 555 1234</phone>
        <country>USA</country>
        <amountRaised>9073</amountRaised>
        <previousAmountRaised>5768</previousAmountRaised>
        <messagesSent>5</messagesSent>
        <messagesOpened>3</messagesOpened>
        <clickThroughs>1</clickThroughs>
        <group>
            <id>201</id>
            <name>Group 1</name>
            <contactsCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        </group>
        <acknowledged xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </addressBookContact>
    <addressBookContact>
        <id>103</id>
        <firstName>Sam</firstName>
        <lastName>Ple3</lastName>
        <email>sample3@example.com</email>
        <street1>1234 Some St.</street1>
        <street2>#42</street2>
        <street3></street3>
        <city>Austin</city>
        <county>Travis</county>
        <state>TX</state>
        <zip>78758</zip>
        <phone>(512) 555 1234</phone>
        <country>USA</country>
        <amountRaised>8055</amountRaised>
        <previousAmountRaised>9596</previousAmountRaised>
        <messagesSent>5</messagesSent>
        <messagesOpened>3</messagesOpened>
        <clickThroughs>1</clickThroughs>
        <group>
            <id>201</id>
            <name>Group 1</name>
            <contactsCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        </group>
        <group>
            <id>202</id>
            <name>Group 2</name>
            <contactsCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        </group>
        <acknowledged xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </addressBookContact>
</getTeamraiserAddressBookContactsResponse>

JSON response

{"getTeamraiserAddressBookContactsResponse":{"totalNumberResults":"3","addressBookContact":[{"street2":"#42","lastName":"Ple1","street1":"1234 Some St.","zip":"78758","phone":"(512) 555 1234","state":"TX","messagesSent":"5","country":"USA","city":"Austin","id":"101","clickThroughs":"1","email":"sample1@example.com","county":"Travis","messagesOpened":"3","acknowledged":null,"amountRaised":"10159","firstName":"Sam","previousAmountRaised":"6524","street3":""},{"street2":"#42","lastName":"Ple2","street1":"1234 Some St.","zip":"78758","phone":"(512) 555 1234","state":"TX","messagesSent":"5","country":"USA","city":"Austin","id":"102","clickThroughs":"1","email":"sample2@example.com","county":"Travis","messagesOpened":"3","acknowledged":null,"amountRaised":"12313","group":{"id":"201","name":"Group 1","contactsCount":null},"firstName":"Sam","previousAmountRaised":"5006","street3":""},{"street2":"#42","lastName":"Ple3","street1":"1234 Some St.","zip":"78758","phone":"(512) 555 1234","state":"TX","messagesSent":"5","country":"USA","city":"Austin","id":"103","clickThroughs":"1","email":"sample3@example.com","county":"Travis","messagesOpened":"3","acknowledged":null,"amountRaised":"6757","group":[{"id":"201","name":"Group 1","contactsCount":null},{"id":"202","name":"Group 2","contactsCount":null}],"firstName":"Sam","previousAmountRaised":"13874","street3":""}]}}

Luminate Online

getTeamraiserAddressBookContacts

Client API Syntax

Usage Notes

Client API Parameters

Response

Leave a Comment