MemoryGivingAPIWebService_v2
Click here for a complete list of operations.
updateDonation
Please supply the following fields:
| Parameter | Type | Mandatory | Default | Description |
| api_key | string | Mandatory | Your unique code to access this operation. | |
| user_id | int | Mandatory | The Memory Giving User ID of the person performing this operation. | |
| donation_id | int | Mandatory | Unique ID that identifies each donation. | |
| display_name | string | Mandatory | The name displayed when anonymous is supplied as false. Usually the donors name, but can be used to describe a group of donors e.g. Smith family. | |
| hide_donation_value | bool | Optional | false | Indicates whether the donation value should be hidden. |
| anonymous | bool | Optional | false | Indicates whether this donation should be made anonymously. |
| anonymous_report | bool | Optional | false | Indicates whether the donor details appear anonymously within closed reports to next of kin, funeral director & charity. |
| message | string | Optional | A message from the donor to the deceased or the deceased’s family when anonymous is supplied as false. |
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/v2/WebService.asmx HTTP/1.1
Host: memorygiving.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://memorygiving.com/admin/api/v2/WebService.asmx/updateDonation"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<updateDonation xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</updateDonation>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<updateDonationResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<updateDonationResult>
<Data>
<id>int</id>
<tribute_id>int</tribute_id>
<charity_id>int</charity_id>
<anonymous>boolean</anonymous>
<display_name>string</display_name>
<message>string</message>
<donation>double</donation>
<donation_online>boolean</donation_online>
<hide_donation_value>boolean</hide_donation_value>
<gift_aid>boolean</gift_aid>
<date_donation>dateTime</date_donation>
<value_gift_aid>double</value_gift_aid>
<PaymentGatewayURL>string</PaymentGatewayURL>
<CurrencyDonation>string</CurrencyDonation>
<CurrencyGiftAid>string</CurrencyGiftAid>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</updateDonationResult>
</updateDonationResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/v2/WebService.asmx HTTP/1.1
Host: memorygiving.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<updateDonation xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</updateDonation>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<updateDonationResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<updateDonationResult>
<Data>
<id>int</id>
<tribute_id>int</tribute_id>
<charity_id>int</charity_id>
<anonymous>boolean</anonymous>
<display_name>string</display_name>
<message>string</message>
<donation>double</donation>
<donation_online>boolean</donation_online>
<hide_donation_value>boolean</hide_donation_value>
<gift_aid>boolean</gift_aid>
<date_donation>dateTime</date_donation>
<value_gift_aid>double</value_gift_aid>
<PaymentGatewayURL>string</PaymentGatewayURL>
<CurrencyDonation>string</CurrencyDonation>
<CurrencyGiftAid>string</CurrencyGiftAid>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</updateDonationResult>
</updateDonationResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /admin/api/v2/WebService.asmx/updateDonation?api_key=string HTTP/1.1 Host: memorygiving.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ResponseOfDonation xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<Data>
<id>int</id>
<tribute_id>int</tribute_id>
<charity_id>int</charity_id>
<anonymous>boolean</anonymous>
<display_name>string</display_name>
<message>string</message>
<donation>double</donation>
<donation_online>boolean</donation_online>
<hide_donation_value>boolean</hide_donation_value>
<gift_aid>boolean</gift_aid>
<date_donation>dateTime</date_donation>
<value_gift_aid>double</value_gift_aid>
<PaymentGatewayURL>string</PaymentGatewayURL>
<CurrencyDonation>string</CurrencyDonation>
<CurrencyGiftAid>string</CurrencyGiftAid>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</ResponseOfDonation>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /admin/api/v2/WebService.asmx/updateDonation HTTP/1.1 Host: memorygiving.com Content-Type: application/x-www-form-urlencoded Content-Length: length api_key=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ResponseOfDonation xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<Data>
<id>int</id>
<tribute_id>int</tribute_id>
<charity_id>int</charity_id>
<anonymous>boolean</anonymous>
<display_name>string</display_name>
<message>string</message>
<donation>double</donation>
<donation_online>boolean</donation_online>
<hide_donation_value>boolean</hide_donation_value>
<gift_aid>boolean</gift_aid>
<date_donation>dateTime</date_donation>
<value_gift_aid>double</value_gift_aid>
<PaymentGatewayURL>string</PaymentGatewayURL>
<CurrencyDonation>string</CurrencyDonation>
<CurrencyGiftAid>string</CurrencyGiftAid>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</ResponseOfDonation>