getTeamraiserAddressBookContactsGiftHistory

Returns gift history for a participant's address book contacts aggregated by contact and event.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRTeamraiserAPI None. GET, POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getTeamraiserAddressBookContactsGiftHistory &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 [ &contact_id=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

contact_id

Optional. The system-generated unique contact ID for the contact.

Type xsd:nonNegativeInteger.

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"?>
<getTeamraiserAddressBookContactsGiftHistoryResponse 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">
  <eventContactGiftHistory>
    <fr_id>1000</fr_id>
    <internal_event_name>Internal Event Name</internal_event_name>
    <external_event_name>External Event Name</external_event_name>
    <primary_classification>Primary Classification</primary_classification>
    <event_date>2016-02-01T09:43:40.055-06:00</event_date>
    <contact_id>1001</contact_id>
    <amount>250.0</amount>
  </eventContactGiftHistory>
</getTeamraiserAddressBookContactsGiftHistoryResponse>
JSON response
{"getTeamraiserAddressBookContactsGiftHistoryResponse":{"eventContactGiftHistory":{"amount":"250.0","fr_id":"1000","contact_id":"1001","event_date":"2016-02-01T09:43:40.057-06:00","internal_event_name":"Internal Event Name","external_event_name":"External Event Name","primary_classification":"Primary Classification"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: