Luminate Online

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=getContactActivity &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 ] &contact_id=value &fr_id=value [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

contact_id

Required. A unique ID to identify an address book contact.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

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"?>
<getContactActivityResponse 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">
  <contactActivityRecord>
    <activity>Sample activity 01</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>DONATION</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 11</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>MESSAGE</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 21</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>RECRUIT</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 31</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>DONATION</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 41</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>MESSAGE</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 51</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>RECRUIT</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 61</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>DONATION</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 71</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>MESSAGE</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 81</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>RECRUIT</type>
    <date>January 1</date>
  </contactActivityRecord>
  <contactActivityRecord>
    <activity>Sample activity 91</activity>
    <body>Body text here.</body>
    <subject>Subject here</subject>
    <type>DONATION</type>
    <date>January 1</date>
  </contactActivityRecord>
</getContactActivityResponse>

JSON response

{"getContactActivityResponse":{"contactActivityRecord":[{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"DONATION","activity":"Sample activity 01"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"MESSAGE","activity":"Sample activity 11"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"RECRUIT","activity":"Sample activity 21"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"DONATION","activity":"Sample activity 31"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"MESSAGE","activity":"Sample activity 41"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"RECRUIT","activity":"Sample activity 51"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"DONATION","activity":"Sample activity 61"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"MESSAGE","activity":"Sample activity 71"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"RECRUIT","activity":"Sample activity 81"},{"body":"Body text here.","subject":"Subject here","date":"January 1","type":"DONATION","activity":"Sample activity 91"}]}}

getContactActivity

Client API Syntax

Client API Parameters

Response

Leave a Comment