MemoryGivingAPIWebService_v2
Click here for a complete list of operations.
suggestCharity
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. | |
| charity_name | string | Mandatory | Name of the suggested charity. | |
| charity_number | string | Optional | Charity number of the suggested charity. |
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/suggestCharity"
<?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>
<suggestCharity xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</suggestCharity>
</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>
<suggestCharityResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<suggestCharityResult>
<Data>
<id>int</id>
<charity_name>string</charity_name>
<aliases>string</aliases>
<is_charity>boolean</is_charity>
<charity_number>string</charity_number>
<description>string</description>
<web>string</web>
<logo_path>string</logo_path>
<image_byte_array>base64Binary</image_byte_array>
<cropped_logo_path>string</cropped_logo_path>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</suggestCharityResult>
</suggestCharityResponse>
</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>
<suggestCharity xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</suggestCharity>
</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>
<suggestCharityResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<suggestCharityResult>
<Data>
<id>int</id>
<charity_name>string</charity_name>
<aliases>string</aliases>
<is_charity>boolean</is_charity>
<charity_number>string</charity_number>
<description>string</description>
<web>string</web>
<logo_path>string</logo_path>
<image_byte_array>base64Binary</image_byte_array>
<cropped_logo_path>string</cropped_logo_path>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</suggestCharityResult>
</suggestCharityResponse>
</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/suggestCharity?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"?>
<ResponseOfCharity xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<Data>
<id>int</id>
<charity_name>string</charity_name>
<aliases>string</aliases>
<is_charity>boolean</is_charity>
<charity_number>string</charity_number>
<description>string</description>
<web>string</web>
<logo_path>string</logo_path>
<image_byte_array>base64Binary</image_byte_array>
<cropped_logo_path>string</cropped_logo_path>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</ResponseOfCharity>
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/suggestCharity 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"?>
<ResponseOfCharity xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<Data>
<id>int</id>
<charity_name>string</charity_name>
<aliases>string</aliases>
<is_charity>boolean</is_charity>
<charity_number>string</charity_number>
<description>string</description>
<web>string</web>
<logo_path>string</logo_path>
<image_byte_array>base64Binary</image_byte_array>
<cropped_logo_path>string</cropped_logo_path>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</ResponseOfCharity>