Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

gift_id

Required. Unique gift 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 version="1.0" encoding="UTF-8"?>
<getGiftResponse 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">
  <gift>
    <acknowledged>false</acknowledged>
    <checkNumber xsi:nil="true"/>
    <confirmed>true</confirmed>
    <date>2016-02-01T09:43:43.043-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>
</getGiftResponse>

        

{"getGiftResponse":{"gift":{"giftMessage":"Sample gift message.","isRecurring":"false","paymentType":"CREDIT","checkNumber":null,"date":"2016-02-01T09:43:43.044-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"}}}