getEventGifts

Generate a list of gifts from a specific TeamRaiser event. The list can be filtered by creation date, modifications date, security category, or other database fields. The list can also be sorted by any column.

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

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=getEventGifts & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & fr_id =value [ & creation_end_date =value ] [ & creation_start_date =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 ] [ & modify_end_date =value ] [ & modify_start_date =value ]

Usage Notes

Filter

TeamRaiser – Required. Select a single TeamRaiser identifier (fr_id). The response will only include gifts associated with this TeamRaiser.

  • Time Range –
    • Optional. Select a time range with creation_start_date and creation_end_date. The response will only include gifts created within that range.
    • Optional. Select a time range with modification_start_date and modified_end_date. The response will only include gifts modified within that range.
    • Optional. Do not select a time range and return all values associated with the specified TeamRaiser.

    NOTE: You cannot select both a creation time range AND a modification time range.

  • Database column value – Optional. Select a database column (list_filter_column) and limit the response to data that contains a specific value (list_filter_text) within that column.
  • Security category – Disabled.

Sort

Optional. Select a database column (list_sort_column) and choose ascending or descending sorting (list_ascending) based on that column’s values.

Customize pagination

  • Optional. Each page displays twenty-five results unless you specify a different value (list_page_size).
  • Optional. The list begins at the first record and page unless you specify a different record (list_record_offset) or page (list_page_offset). The page and record numbering begins at 0 (e.g., page 2 is list_page_offset=3).

NOTE: You must set a page size if you set a page or record offset. You can set a page offset or a record offset, but not both.

getEventGifts Error

The below exception occurs when an event is not found, not published, or archived.

2601The event you requested does not exist or is not available.

See Generic API Error Response Codes for common error codes.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

creation_end_date

Optional. The end date of a date range in which to return event gifts created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.

Type xsd:dateTime.

creation_start_date

Optional. The start date of a date range in which to return event gifts created within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.

Type xsd:dateTime.

list_ascending

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

Type xsd:boolean.

Default is true.

list_category_id

Disabled.

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.

modify_end_date

Optional. The end date of a date range in which to return event gifts modified within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.

Type xsd:dateTime.

modify_start_date

Optional. The start date of a date range in which to return event gifts modified within the date range. Format the date as YYYY-MM-DD per ISO 8601 specifications, such as, 2022-09-30.

Type xsd:dateTime.

Response

See topic HTTP Status Codes.

XML response 

<?xml version="1.0" encoding="UTF-8"?>
<getEventGiftsResponse 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>
    <rejected>false</rejected>
    <created_date>2022-12-29T16:21:01.090-06:00</created_date>
    <modify_date>2022-12-29T16:21:01.090-06:00</modify_date>
    <isRegistration>true</isRegistration>
    <isOnlineGift>true</isOnlineGift>
    <upsellAmount>0</upsellAmount>
    <regFeeAmount>0</regFeeAmount>
    <giftAmount>2501</giftAmount>
    <participantEmail>name1@example.com</participantEmail>
    <participantEmail>name2@example.com</participantEmail>
    <supporterEmail>name2@example.com</supporterEmail>
    <giftAidStatus>1</giftAidStatus>
    <giftMessage>Sample gift message.</giftMessage>
    <id>12001</id>
    <isRecurring>false</isRecurring>
    <participantName>
      <first>Jo</first>
      <middle>1</middle>
      <last>Public</last>
    </participantName>
    <supporterName>
      <first>Jo</first>
      <middle>2</middle>
      <last>Public</last>
    </supporterName>
    <paymentType>CREDIT</paymentType>
    <recognitionName>Sample recognition name 1</recognitionName>
    <proxyType>TEAMRAISER_PARTICIPANT</proxyType>
  </gift>
  <gift>
    <acknowledged>false</acknowledged>
    <checkNumber xsi:nil="true"/>
    <confirmed>true</confirmed>
    <rejected>false</rejected>
    <created_date>2022-12-29T16:21:01.092-06:00</created_date>
    <modify_date>2022-12-29T16:21:01.092-06:00</modify_date>
    <isRegistration>true</isRegistration>
    <isOnlineGift>true</isOnlineGift>
    <upsellAmount>0</upsellAmount>
    <regFeeAmount>0</regFeeAmount>
    <giftAmount>2502</giftAmount>
    <participantEmail>name1@example.com</participantEmail>
    <participantEmail>name2@example.com</participantEmail>
    <supporterEmail>name2@example.com</supporterEmail>
    <giftAidStatus>1</giftAidStatus>
    <giftMessage>Sample gift message.</giftMessage>
    <id>12002</id>
    <isRecurring>false</isRecurring>
    <participantName>
      <first>Jo</first>
      <middle>2</middle>
      <last>Public</last>
    </participantName>
    <supporterName>
      <first>Jo</first>
      <middle>3</middle>
      <last>Public</last>
    </supporterName>
    <paymentType>CREDIT</paymentType>
    <recognitionName>Sample recognition name 2</recognitionName>
    <proxyType>TEAMRAISER_PARTICIPANT</proxyType>
  </gift>
</getEventGiftsResponse>
JSON response 
{
    "getEventGiftsResponse": {
        "gift": [
            {
                "giftAmount": "2501",
                "isRegistration": "true",
                "supporterEmail": "name2@example.com",
                "supporterName": {
                    "middle": "2",
                    "last": "Public",
                    "first": "Jo"
                },
                "checkNumber": null,
                "acknowledged": "false",
                "giftMessage": "Sample gift message.",
                "rejected": "false",
                "giftAidStatus": "1",
                "proxyType": "TEAMRAISER_PARTICIPANT",
                "isRecurring": "false",
                "participantEmail": [
                    "name1@example.com",
                    "name2@example.com"
                ],
                "confirmed": "true",
                "regFeeAmount": "0",
                "paymentType": "CREDIT",
                "isOnlineGift": "true",
                "created_date": "2023-01-24T16:03:33.527-06:00",
                "id": "12001",
                "participantName": {
                    "middle": "1",
                    "last": "Public",
                    "first": "Jo"
                },
                "modify_date": "2023-01-24T16:03:33.528-06:00",
                "recognitionName": "Sample recognition name 1",
                "upsellAmount": "0"
            },
            {
                "giftAmount": "2502",
                "isRegistration": "true",
                "supporterEmail": "name2@example.com",
                "supporterName": {
                    "middle": "3",
                    "last": "Public",
                    "first": "Jo"
                },
                "checkNumber": null,
                "acknowledged": "false",
                "giftMessage": "Sample gift message.",
                "rejected": "false",
                "giftAidStatus": "1",
                "proxyType": "TEAMRAISER_PARTICIPANT",
                "isRecurring": "false",
                "participantEmail": [
                    "name1@example.com",
                    "name2@example.com"
                ],
                "confirmed": "true",
                "regFeeAmount": "0",
                "paymentType": "CREDIT",
                "isOnlineGift": "true",
                "created_date": "2023-01-24T16:03:33.528-06:00",
                "id": "12002",
                "participantName": {
                    "middle": "2",
                    "last": "Public",
                    "first": "Jo"
                },
                "modify_date": "2023-01-24T16:03:33.528-06:00",
                "recognitionName": "Sample recognition name 2",
                "upsellAmount": "0"
            }
        ],
        "totalNumberResults": "2"
    }
}
Parent topic: TeamRaiser API
Previous topic: getEventDataParameter
Next topic: getFlowStep

Leave a Comment

Nickname
Comment
Enter this word:
Change