MemoryGivingAPIWebService


Click here for a complete list of operations.

addCharityToTribute

Please supply the following fields:
ParameterTypeMandatoryDefaultDescription
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.
tribute_id int Mandatory Unique ID that identifies each fund page.
charity_ids string Mandatory Comma separated charity IDs

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

<?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>
    <addCharityToTribute xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </addCharityToTribute>
  </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>
    <addCharityToTributeResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <addCharityToTributeResult>
        <Data>
          <id>int</id>
          <page_name>string</page_name>
          <aliases>string</aliases>
          <fd_id>int</fd_id>
          <charity_id>int</charity_id>
          <name>string</name>
          <age>string</age>
          <photo_byte_array>base64Binary</photo_byte_array>
          <colour>int</colour>
          <date_of_death>dateTime</date_of_death>
          <facebook_link>string</facebook_link>
          <message>string</message>
          <service_display>boolean</service_display>
          <service_date_time>dateTime</service_date_time>
          <service_chapel>string</service_chapel>
          <service_address>string</service_address>
          <service_location>string</service_location>
          <service_notes>string</service_notes>
          <committal_display>boolean</committal_display>
          <committal_address>string</committal_address>
          <committal_location>string</committal_location>
          <reception_display>boolean</reception_display>
          <reception_date_time>dateTime</reception_date_time>
          <reception_address>string</reception_address>
          <reception_location>string</reception_location>
          <t_address1>string</t_address1>
          <t_address2>string</t_address2>
          <t_town>string</t_town>
          <t_post_code>string</t_post_code>
          <contact_name>string</contact_name>
          <contact_relationship>string</contact_relationship>
          <contact_email>string</contact_email>
          <contact_address1>string</contact_address1>
          <contact_address2>string</contact_address2>
          <contact_town>string</contact_town>
          <contact_post_code>string</contact_post_code>
          <enabled>boolean</enabled>
          <date_created>dateTime</date_created>
          <date_updated>dateTime</date_updated>
          <date_closed>dateTime</date_closed>
          <funeral_director>
            <id>int</id>
            <company_name>string</company_name>
            <address1>string</address1>
            <address2>string</address2>
            <town>string</town>
            <postcode>string</postcode>
            <description>string</description>
            <web>string</web>
            <contact_first_name>string</contact_first_name>
            <contact_last_name>string</contact_last_name>
            <contact_email>string</contact_email>
            <telephone_1_label>string</telephone_1_label>
            <telephone_1>string</telephone_1>
            <telephone_2_label>string</telephone_2_label>
            <telephone_2>string</telephone_2>
            <cropped_logo_path>string</cropped_logo_path>
            <trade_body>string</trade_body>
          </funeral_director>
          <charity>
            <id>int</id>
            <charity_name>string</charity_name>
            <aliases>string</aliases>
            <charity_number>string</charity_number>
            <description>string</description>
            <web>string</web>
            <cropped_logo_path>string</cropped_logo_path>
          </charity>
          <donations>
            <anyType />
            <anyType />
          </donations>
          <donations_total>double</donations_total>
          <donations_online_total>double</donations_online_total>
          <donations_offline_total>double</donations_offline_total>
          <gift_aid_total>double</gift_aid_total>
          <tribute_group_id>int</tribute_group_id>
          <tribute_group>
            <id>int</id>
            <page_name>string</page_name>
            <tributes xsi:nil="true" />
            <remove xsi:nil="true" />
            <donations_total>double</donations_total>
            <donations_online_total>double</donations_online_total>
            <donations_offline_total>double</donations_offline_total>
            <gift_aid_total>double</gift_aid_total>
            <PageURL>string</PageURL>
            <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
            <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
            <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
            <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
          </tribute_group>
          <cropped_photo_path>string</cropped_photo_path>
          <cropped_photo_thumb_path>string</cropped_photo_thumb_path>
          <isOpen>boolean</isOpen>
          <DonationFormURL>string</DonationFormURL>
          <ColourHex>string</ColourHex>
          <PageURL>string</PageURL>
          <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
          <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
          <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
          <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </addCharityToTributeResult>
    </addCharityToTributeResponse>
  </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>
    <addCharityToTribute xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </addCharityToTribute>
  </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>
    <addCharityToTributeResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <addCharityToTributeResult>
        <Data>
          <id>int</id>
          <page_name>string</page_name>
          <aliases>string</aliases>
          <fd_id>int</fd_id>
          <charity_id>int</charity_id>
          <name>string</name>
          <age>string</age>
          <photo_byte_array>base64Binary</photo_byte_array>
          <colour>int</colour>
          <date_of_death>dateTime</date_of_death>
          <facebook_link>string</facebook_link>
          <message>string</message>
          <service_display>boolean</service_display>
          <service_date_time>dateTime</service_date_time>
          <service_chapel>string</service_chapel>
          <service_address>string</service_address>
          <service_location>string</service_location>
          <service_notes>string</service_notes>
          <committal_display>boolean</committal_display>
          <committal_address>string</committal_address>
          <committal_location>string</committal_location>
          <reception_display>boolean</reception_display>
          <reception_date_time>dateTime</reception_date_time>
          <reception_address>string</reception_address>
          <reception_location>string</reception_location>
          <t_address1>string</t_address1>
          <t_address2>string</t_address2>
          <t_town>string</t_town>
          <t_post_code>string</t_post_code>
          <contact_name>string</contact_name>
          <contact_relationship>string</contact_relationship>
          <contact_email>string</contact_email>
          <contact_address1>string</contact_address1>
          <contact_address2>string</contact_address2>
          <contact_town>string</contact_town>
          <contact_post_code>string</contact_post_code>
          <enabled>boolean</enabled>
          <date_created>dateTime</date_created>
          <date_updated>dateTime</date_updated>
          <date_closed>dateTime</date_closed>
          <funeral_director>
            <id>int</id>
            <company_name>string</company_name>
            <address1>string</address1>
            <address2>string</address2>
            <town>string</town>
            <postcode>string</postcode>
            <description>string</description>
            <web>string</web>
            <contact_first_name>string</contact_first_name>
            <contact_last_name>string</contact_last_name>
            <contact_email>string</contact_email>
            <telephone_1_label>string</telephone_1_label>
            <telephone_1>string</telephone_1>
            <telephone_2_label>string</telephone_2_label>
            <telephone_2>string</telephone_2>
            <cropped_logo_path>string</cropped_logo_path>
            <trade_body>string</trade_body>
          </funeral_director>
          <charity>
            <id>int</id>
            <charity_name>string</charity_name>
            <aliases>string</aliases>
            <charity_number>string</charity_number>
            <description>string</description>
            <web>string</web>
            <cropped_logo_path>string</cropped_logo_path>
          </charity>
          <donations>
            <anyType />
            <anyType />
          </donations>
          <donations_total>double</donations_total>
          <donations_online_total>double</donations_online_total>
          <donations_offline_total>double</donations_offline_total>
          <gift_aid_total>double</gift_aid_total>
          <tribute_group_id>int</tribute_group_id>
          <tribute_group>
            <id>int</id>
            <page_name>string</page_name>
            <tributes xsi:nil="true" />
            <remove xsi:nil="true" />
            <donations_total>double</donations_total>
            <donations_online_total>double</donations_online_total>
            <donations_offline_total>double</donations_offline_total>
            <gift_aid_total>double</gift_aid_total>
            <PageURL>string</PageURL>
            <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
            <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
            <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
            <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
          </tribute_group>
          <cropped_photo_path>string</cropped_photo_path>
          <cropped_photo_thumb_path>string</cropped_photo_thumb_path>
          <isOpen>boolean</isOpen>
          <DonationFormURL>string</DonationFormURL>
          <ColourHex>string</ColourHex>
          <PageURL>string</PageURL>
          <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
          <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
          <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
          <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </addCharityToTributeResult>
    </addCharityToTributeResponse>
  </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/addCharityToTribute?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"?>
<ResponseOfTribute xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <id>int</id>
    <page_name>string</page_name>
    <aliases>string</aliases>
    <fd_id>int</fd_id>
    <charity_id>int</charity_id>
    <name>string</name>
    <age>string</age>
    <photo_byte_array>base64Binary</photo_byte_array>
    <colour>int</colour>
    <date_of_death>dateTime</date_of_death>
    <facebook_link>string</facebook_link>
    <message>string</message>
    <service_display>boolean</service_display>
    <service_date_time>dateTime</service_date_time>
    <service_chapel>string</service_chapel>
    <service_address>string</service_address>
    <service_location>string</service_location>
    <service_notes>string</service_notes>
    <committal_display>boolean</committal_display>
    <committal_address>string</committal_address>
    <committal_location>string</committal_location>
    <reception_display>boolean</reception_display>
    <reception_date_time>dateTime</reception_date_time>
    <reception_address>string</reception_address>
    <reception_location>string</reception_location>
    <t_address1>string</t_address1>
    <t_address2>string</t_address2>
    <t_town>string</t_town>
    <t_post_code>string</t_post_code>
    <contact_name>string</contact_name>
    <contact_relationship>string</contact_relationship>
    <contact_email>string</contact_email>
    <contact_address1>string</contact_address1>
    <contact_address2>string</contact_address2>
    <contact_town>string</contact_town>
    <contact_post_code>string</contact_post_code>
    <enabled>boolean</enabled>
    <date_created>dateTime</date_created>
    <date_updated>dateTime</date_updated>
    <date_closed>dateTime</date_closed>
    <funeral_director>
      <id>int</id>
      <company_name>string</company_name>
      <address1>string</address1>
      <address2>string</address2>
      <town>string</town>
      <postcode>string</postcode>
      <description>string</description>
      <web>string</web>
      <contact_first_name>string</contact_first_name>
      <contact_last_name>string</contact_last_name>
      <contact_email>string</contact_email>
      <telephone_1_label>string</telephone_1_label>
      <telephone_1>string</telephone_1>
      <telephone_2_label>string</telephone_2_label>
      <telephone_2>string</telephone_2>
      <cropped_logo_path>string</cropped_logo_path>
      <trade_body>string</trade_body>
    </funeral_director>
    <charity>
      <id>int</id>
      <charity_name>string</charity_name>
      <aliases>string</aliases>
      <charity_number>string</charity_number>
      <description>string</description>
      <web>string</web>
      <cropped_logo_path>string</cropped_logo_path>
    </charity>
    <donations>
      <anyType />
      <anyType />
    </donations>
    <donations_total>double</donations_total>
    <donations_online_total>double</donations_online_total>
    <donations_offline_total>double</donations_offline_total>
    <gift_aid_total>double</gift_aid_total>
    <tribute_group_id>int</tribute_group_id>
    <tribute_group>
      <id>int</id>
      <page_name>string</page_name>
      <tributes>
        <anyType />
        <anyType />
      </tributes>
      <remove>
        <anyType />
        <anyType />
      </remove>
      <donations_total>double</donations_total>
      <donations_online_total>double</donations_online_total>
      <donations_offline_total>double</donations_offline_total>
      <gift_aid_total>double</gift_aid_total>
      <PageURL>string</PageURL>
      <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
      <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
      <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
      <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
    </tribute_group>
    <cropped_photo_path>string</cropped_photo_path>
    <cropped_photo_thumb_path>string</cropped_photo_thumb_path>
    <isOpen>boolean</isOpen>
    <DonationFormURL>string</DonationFormURL>
    <ColourHex>string</ColourHex>
    <PageURL>string</PageURL>
    <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
    <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
    <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
    <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfTribute>

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/addCharityToTribute 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"?>
<ResponseOfTribute xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <id>int</id>
    <page_name>string</page_name>
    <aliases>string</aliases>
    <fd_id>int</fd_id>
    <charity_id>int</charity_id>
    <name>string</name>
    <age>string</age>
    <photo_byte_array>base64Binary</photo_byte_array>
    <colour>int</colour>
    <date_of_death>dateTime</date_of_death>
    <facebook_link>string</facebook_link>
    <message>string</message>
    <service_display>boolean</service_display>
    <service_date_time>dateTime</service_date_time>
    <service_chapel>string</service_chapel>
    <service_address>string</service_address>
    <service_location>string</service_location>
    <service_notes>string</service_notes>
    <committal_display>boolean</committal_display>
    <committal_address>string</committal_address>
    <committal_location>string</committal_location>
    <reception_display>boolean</reception_display>
    <reception_date_time>dateTime</reception_date_time>
    <reception_address>string</reception_address>
    <reception_location>string</reception_location>
    <t_address1>string</t_address1>
    <t_address2>string</t_address2>
    <t_town>string</t_town>
    <t_post_code>string</t_post_code>
    <contact_name>string</contact_name>
    <contact_relationship>string</contact_relationship>
    <contact_email>string</contact_email>
    <contact_address1>string</contact_address1>
    <contact_address2>string</contact_address2>
    <contact_town>string</contact_town>
    <contact_post_code>string</contact_post_code>
    <enabled>boolean</enabled>
    <date_created>dateTime</date_created>
    <date_updated>dateTime</date_updated>
    <date_closed>dateTime</date_closed>
    <funeral_director>
      <id>int</id>
      <company_name>string</company_name>
      <address1>string</address1>
      <address2>string</address2>
      <town>string</town>
      <postcode>string</postcode>
      <description>string</description>
      <web>string</web>
      <contact_first_name>string</contact_first_name>
      <contact_last_name>string</contact_last_name>
      <contact_email>string</contact_email>
      <telephone_1_label>string</telephone_1_label>
      <telephone_1>string</telephone_1>
      <telephone_2_label>string</telephone_2_label>
      <telephone_2>string</telephone_2>
      <cropped_logo_path>string</cropped_logo_path>
      <trade_body>string</trade_body>
    </funeral_director>
    <charity>
      <id>int</id>
      <charity_name>string</charity_name>
      <aliases>string</aliases>
      <charity_number>string</charity_number>
      <description>string</description>
      <web>string</web>
      <cropped_logo_path>string</cropped_logo_path>
    </charity>
    <donations>
      <anyType />
      <anyType />
    </donations>
    <donations_total>double</donations_total>
    <donations_online_total>double</donations_online_total>
    <donations_offline_total>double</donations_offline_total>
    <gift_aid_total>double</gift_aid_total>
    <tribute_group_id>int</tribute_group_id>
    <tribute_group>
      <id>int</id>
      <page_name>string</page_name>
      <tributes>
        <anyType />
        <anyType />
      </tributes>
      <remove>
        <anyType />
        <anyType />
      </remove>
      <donations_total>double</donations_total>
      <donations_online_total>double</donations_online_total>
      <donations_offline_total>double</donations_offline_total>
      <gift_aid_total>double</gift_aid_total>
      <PageURL>string</PageURL>
      <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
      <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
      <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
      <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
    </tribute_group>
    <cropped_photo_path>string</cropped_photo_path>
    <cropped_photo_thumb_path>string</cropped_photo_thumb_path>
    <isOpen>boolean</isOpen>
    <DonationFormURL>string</DonationFormURL>
    <ColourHex>string</ColourHex>
    <PageURL>string</PageURL>
    <CurrencyDonationsTotal>string</CurrencyDonationsTotal>
    <CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
    <CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
    <CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfTribute>