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=getTeamraiserAddressBookContact &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"?>
<getTeamraiserAddressBookContactResponse 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">
  <addressBookContact>
    <id>101</id>
    <firstName>Sam</firstName>
    <lastName>Ple1</lastName>
    <email>sample1@example.com</email>
    <street1>1234 Some St.</street1>
    <street2>#42</street2>
    <street3/>
    <city>Austin</city>
    <county>Travis</county>
    <state>TX</state>
    <zip>78758</zip>
    <phone>(512) 555 1234</phone>
    <country>USA</country>
    <amountRaised>6439</amountRaised>
    <messagesSent>5</messagesSent>
    <messagesOpened>3</messagesOpened>
    <clickThroughs>1</clickThroughs>
    <group>
      <name>Group 1</name>
      <id>201</id>
    </group>
    <group>
      <name>Group 2</name>
      <id>202</id>
    </group>
    <group>
      <name>Group 3</name>
      <id>203</id>
    </group>
  </addressBookContact>
</getTeamraiserAddressBookContactResponse>

JSON response

{"getTeamraiserAddressBookContactResponse":{"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","amountRaised":"7861","group":[{"id":"201","name":"Group 1"},{"id":"202","name":"Group 2"},{"id":"203","name":"Group 3"}],"firstName":"Sam","street3":{}}}}

getTeamraiserAddressBookContact

Client API Syntax

Client API Parameters

Response

Leave a Comment