Luminate Online

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

Client API Syntax

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

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.

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.

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"?>
<getGiftsResponse 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">
  <totalNumberResults>2</totalNumberResults>
  <gift>
    <acknowledged>false</acknowledged>
    <checkNumber xsi:nil="true"/>
    <confirmed>true</confirmed>
    <date>2016-02-01T09:43:40.089-06:00</date>
    <email>name1@example.com</email>
    <giftAmount>2501</giftAmount>
    <giftAidStatus>1</giftAidStatus>
    <giftMessage>Sample gift message.</giftMessage>
    <id>12001</id>
    <isRecurring>false</isRecurring>
    <name>
      <first>Jo</first>
      <middle>1</middle>
      <last>Public</last>
    </name>
    <paymentType>CREDIT</paymentType>
    <recognitionName>Sample recognition name 1</recognitionName>
  </gift>
  <gift>
    <acknowledged>false</acknowledged>
    <checkNumber xsi:nil="true"/>
    <confirmed>true</confirmed>
    <date>2016-02-01T09:43:40.097-06:00</date>
    <email>name1@example.com</email>
    <giftAmount>2502</giftAmount>
    <giftAidStatus>1</giftAidStatus>
    <giftMessage>Sample gift message.</giftMessage>
    <id>12002</id>
    <isRecurring>false</isRecurring>
    <name>
      <first>Jo</first>
      <middle>2</middle>
      <last>Public</last>
    </name>
    <paymentType>CREDIT</paymentType>
    <recognitionName>Sample recognition name 2</recognitionName>
  </gift>
</getGiftsResponse>

JSON response

{"getGiftsResponse":{"gift":[{"giftMessage":"Sample gift message.","isRecurring":"false","paymentType":"CREDIT","checkNumber":null,"date":"2016-02-01T09:43:40.102-06:00","recognitionName":"Sample recognition name 1","id":"12001","confirmed":"true","email":"name1@example.com","giftAidStatus":"1","acknowledged":"false","name":{"last":"Public","middle":"1","first":"Jo"},"giftAmount":"2501"},{"giftMessage":"Sample gift message.","isRecurring":"false","paymentType":"CREDIT","checkNumber":null,"date":"2016-02-01T09:43:40.102-06:00","recognitionName":"Sample recognition name 2","id":"12002","confirmed":"true","email":"name1@example.com","giftAidStatus":"1","acknowledged":"false","name":{"last":"Public","middle":"2","first":"Jo"},"giftAmount":"2502"}],"totalNumberResults":"2"}}

getGifts

Client API Syntax

Client API Parameters

Response

Leave a Comment