MemoryGivingAPIWebService


Click here for a complete list of operations.

searchCharities

Please supply the following fields:
ParameterTypeMandatoryDefaultDescription
api_key string Mandatory Your unique code to access this operation.
charity_name string Mandatory Name of the charity to search.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
api_key:

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/searchCharities"

<?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>
    <searchCharities xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </searchCharities>
  </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>
    <searchCharitiesResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <searchCharitiesResult>
        <Data>
          <SearchResultItemCharity>
            <ID>int</ID>
            <Name>string</Name>
            <Aliases>string</Aliases>
            <HTML_Name>string</HTML_Name>
            <HTML_Aliases>string</HTML_Aliases>
            <HTML_Number>string</HTML_Number>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Town>string</Town>
            <Postcode>string</Postcode>
            <Country>string</Country>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <ContactTelephone>string</ContactTelephone>
            <IsActivated>boolean</IsActivated>
            <Number>string</Number>
            <LogoPath>string</LogoPath>
          </SearchResultItemCharity>
          <SearchResultItemCharity>
            <ID>int</ID>
            <Name>string</Name>
            <Aliases>string</Aliases>
            <HTML_Name>string</HTML_Name>
            <HTML_Aliases>string</HTML_Aliases>
            <HTML_Number>string</HTML_Number>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Town>string</Town>
            <Postcode>string</Postcode>
            <Country>string</Country>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <ContactTelephone>string</ContactTelephone>
            <IsActivated>boolean</IsActivated>
            <Number>string</Number>
            <LogoPath>string</LogoPath>
          </SearchResultItemCharity>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </searchCharitiesResult>
    </searchCharitiesResponse>
  </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>
    <searchCharities xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </searchCharities>
  </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>
    <searchCharitiesResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <searchCharitiesResult>
        <Data>
          <SearchResultItemCharity>
            <ID>int</ID>
            <Name>string</Name>
            <Aliases>string</Aliases>
            <HTML_Name>string</HTML_Name>
            <HTML_Aliases>string</HTML_Aliases>
            <HTML_Number>string</HTML_Number>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Town>string</Town>
            <Postcode>string</Postcode>
            <Country>string</Country>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <ContactTelephone>string</ContactTelephone>
            <IsActivated>boolean</IsActivated>
            <Number>string</Number>
            <LogoPath>string</LogoPath>
          </SearchResultItemCharity>
          <SearchResultItemCharity>
            <ID>int</ID>
            <Name>string</Name>
            <Aliases>string</Aliases>
            <HTML_Name>string</HTML_Name>
            <HTML_Aliases>string</HTML_Aliases>
            <HTML_Number>string</HTML_Number>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Town>string</Town>
            <Postcode>string</Postcode>
            <Country>string</Country>
            <ContactName>string</ContactName>
            <ContactEmail>string</ContactEmail>
            <ContactTelephone>string</ContactTelephone>
            <IsActivated>boolean</IsActivated>
            <Number>string</Number>
            <LogoPath>string</LogoPath>
          </SearchResultItemCharity>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </searchCharitiesResult>
    </searchCharitiesResponse>
  </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/searchCharities?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"?>
<ResponseOfListOfSearchResultItemCharity xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <SearchResultItemCharity>
      <ID>int</ID>
      <Name>string</Name>
      <Aliases>string</Aliases>
      <HTML_Name>string</HTML_Name>
      <HTML_Aliases>string</HTML_Aliases>
      <HTML_Number>string</HTML_Number>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <Country>string</Country>
      <ContactName>string</ContactName>
      <ContactEmail>string</ContactEmail>
      <ContactTelephone>string</ContactTelephone>
      <IsActivated>boolean</IsActivated>
      <Number>string</Number>
      <LogoPath>string</LogoPath>
    </SearchResultItemCharity>
    <SearchResultItemCharity>
      <ID>int</ID>
      <Name>string</Name>
      <Aliases>string</Aliases>
      <HTML_Name>string</HTML_Name>
      <HTML_Aliases>string</HTML_Aliases>
      <HTML_Number>string</HTML_Number>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <Country>string</Country>
      <ContactName>string</ContactName>
      <ContactEmail>string</ContactEmail>
      <ContactTelephone>string</ContactTelephone>
      <IsActivated>boolean</IsActivated>
      <Number>string</Number>
      <LogoPath>string</LogoPath>
    </SearchResultItemCharity>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfListOfSearchResultItemCharity>

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/searchCharities 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"?>
<ResponseOfListOfSearchResultItemCharity xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <SearchResultItemCharity>
      <ID>int</ID>
      <Name>string</Name>
      <Aliases>string</Aliases>
      <HTML_Name>string</HTML_Name>
      <HTML_Aliases>string</HTML_Aliases>
      <HTML_Number>string</HTML_Number>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <Country>string</Country>
      <ContactName>string</ContactName>
      <ContactEmail>string</ContactEmail>
      <ContactTelephone>string</ContactTelephone>
      <IsActivated>boolean</IsActivated>
      <Number>string</Number>
      <LogoPath>string</LogoPath>
    </SearchResultItemCharity>
    <SearchResultItemCharity>
      <ID>int</ID>
      <Name>string</Name>
      <Aliases>string</Aliases>
      <HTML_Name>string</HTML_Name>
      <HTML_Aliases>string</HTML_Aliases>
      <HTML_Number>string</HTML_Number>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Town>string</Town>
      <Postcode>string</Postcode>
      <Country>string</Country>
      <ContactName>string</ContactName>
      <ContactEmail>string</ContactEmail>
      <ContactTelephone>string</ContactTelephone>
      <IsActivated>boolean</IsActivated>
      <Number>string</Number>
      <LogoPath>string</LogoPath>
    </SearchResultItemCharity>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfListOfSearchResultItemCharity>