MemoryGivingAPIWebService
Click here for a complete list of operations.
search
Please supply the following fields:
Parameter | Type | Mandatory | Default | Description |
api_key | string | Mandatory | Your unique code to access this operation. | |
deceased_name | string | Optional | Deceased name or fund page ID. | |
funeral_director | string | Optional | Funeral Director name or ID. | |
charity | string | Optional | Charity name or ID. | |
show_open | bool | Optional | true | Filter search results to show open fund pages. |
show_closed | bool | Optional | false | Filter search results to show closed fund pages. |
scope_narrow | bool | Optional | false | When the value of the funeral_director parameter is supplied as the Funeral Director ID, the search results will also include other less relevant results that belong to the supplied Funeral Director. By supplying a value of true, only relevant matches for the Funeral Director will be returned. |
include_non_tribute_pages | bool | Optional | false | When the supplied value is true, the search results will also include tribute pages that are not associated with any charities. |
date_limit | DateTime | Optional | 5 years before current datetime | Limits search results to pages created after the supplied date. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss) |
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/WebService.asmx HTTP/1.1 Host: memorygiving.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://memorygiving.com/admin/api/WebService.asmx/search" <?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> <search xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <api_key>string</api_key> </search> </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> <searchResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <searchResult> <Data> <deceased_name>string</deceased_name> <funeral_director>string</funeral_director> <charity>string</charity> <show_open>boolean</show_open> <show_closed>boolean</show_closed> <scope_narrow>boolean</scope_narrow> <show_active>boolean</show_active> <show_inactive>boolean</show_inactive> <searchItems> <anyType /> <anyType /> </searchItems> <date_limit>dateTime</date_limit> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </searchResult> </searchResponse> </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/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> <search xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <api_key>string</api_key> </search> </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> <searchResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <searchResult> <Data> <deceased_name>string</deceased_name> <funeral_director>string</funeral_director> <charity>string</charity> <show_open>boolean</show_open> <show_closed>boolean</show_closed> <scope_narrow>boolean</scope_narrow> <show_active>boolean</show_active> <show_inactive>boolean</show_inactive> <searchItems> <anyType /> <anyType /> </searchItems> <date_limit>dateTime</date_limit> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </searchResult> </searchResponse> </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/WebService.asmx/search?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"?> <ResponseOfSearchResults xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <Data> <deceased_name>string</deceased_name> <funeral_director>string</funeral_director> <charity>string</charity> <show_open>boolean</show_open> <show_closed>boolean</show_closed> <scope_narrow>boolean</scope_narrow> <show_active>boolean</show_active> <show_inactive>boolean</show_inactive> <searchItems> <anyType /> <anyType /> </searchItems> <date_limit>dateTime</date_limit> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </ResponseOfSearchResults>
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/WebService.asmx/search 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"?> <ResponseOfSearchResults xmlns="http://memorygiving.com/admin/api/WebService.asmx"> <Data> <deceased_name>string</deceased_name> <funeral_director>string</funeral_director> <charity>string</charity> <show_open>boolean</show_open> <show_closed>boolean</show_closed> <scope_narrow>boolean</scope_narrow> <show_active>boolean</show_active> <show_inactive>boolean</show_inactive> <searchItems> <anyType /> <anyType /> </searchItems> <date_limit>dateTime</date_limit> </Data> <Error> <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity> <InternalMessage>string</InternalMessage> <FriendlyMessage>string</FriendlyMessage> </Error> </ResponseOfSearchResults>