MemoryGivingAPIWebService_v2
Click here for a complete list of operations.
loadTributeByPageName
Please supply the following fields:
| Parameter | Type | Mandatory | Default | Description |
| api_key | string | Mandatory | Your unique code to access this operation. | |
| page_name | string | Mandatory | Unique page name that identifies each fund page. |
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/loadTributeByPageName"
<?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>
<loadTributeByPageName xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</loadTributeByPageName>
</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>
<loadTributeByPageNameResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<loadTributeByPageNameResult>
<Data>
<contact>
<beneficiary_nok_details>boolean</beneficiary_nok_details>
<name>string</name>
<relationship>Husband or Wife or Partner or Father or Mother or Son or Daughter or Brother or Sister or Grandson or Granddaughter or Uncle or Aunt or Cousin or Nephew or Niece or Friend or Other</relationship>
<email>string</email>
<address1>string</address1>
<address2>string</address2>
<town>string</town>
<overseas>boolean</overseas>
<post_code>string</post_code>
</contact>
<id>int</id>
<page_name>string</page_name>
<aliases>string</aliases>
<name>string</name>
<first_name>string</first_name>
<middle_names>string</middle_names>
<last_name>string</last_name>
<qualifications>string</qualifications>
<date_of_birth>dateTime</date_of_birth>
<date_of_death>dateTime</date_of_death>
<message>string</message>
<events>
<event xsi:nil="true" />
<event xsi:nil="true" />
</events>
<t_address1>string</t_address1>
<t_address2>string</t_address2>
<t_town>string</t_town>
<t_post_code>string</t_post_code>
<enabled>boolean</enabled>
<auto_publish>boolean</auto_publish>
<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>
<aliases>string</aliases>
<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>
<image_byte_array>base64Binary</image_byte_array>
<trade_body>string</trade_body>
</funeral_director>
<charities>
<charity xsi:nil="true" />
<charity xsi:nil="true" />
</charities>
<donations>
<donation xsi:nil="true" />
<donation xsi:nil="true" />
</donations>
<donation_data>
<donations_total>decimal</donations_total>
<donations_online_total>decimal</donations_online_total>
<donations_offline_total>decimal</donations_offline_total>
<gift_aid_total>decimal</gift_aid_total>
<CurrencyDonationsTotal>string</CurrencyDonationsTotal>
<CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
<CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
<CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
</donation_data>
<cropped_photo_path>string</cropped_photo_path>
<DoDMessage>string</DoDMessage>
<isOpen>boolean</isOpen>
<DonationFormURL>string</DonationFormURL>
<PageURL>string</PageURL>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</loadTributeByPageNameResult>
</loadTributeByPageNameResponse>
</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>
<loadTributeByPageName xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<api_key>string</api_key>
</loadTributeByPageName>
</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>
<loadTributeByPageNameResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
<loadTributeByPageNameResult>
<Data>
<contact>
<beneficiary_nok_details>boolean</beneficiary_nok_details>
<name>string</name>
<relationship>Husband or Wife or Partner or Father or Mother or Son or Daughter or Brother or Sister or Grandson or Granddaughter or Uncle or Aunt or Cousin or Nephew or Niece or Friend or Other</relationship>
<email>string</email>
<address1>string</address1>
<address2>string</address2>
<town>string</town>
<overseas>boolean</overseas>
<post_code>string</post_code>
</contact>
<id>int</id>
<page_name>string</page_name>
<aliases>string</aliases>
<name>string</name>
<first_name>string</first_name>
<middle_names>string</middle_names>
<last_name>string</last_name>
<qualifications>string</qualifications>
<date_of_birth>dateTime</date_of_birth>
<date_of_death>dateTime</date_of_death>
<message>string</message>
<events>
<event xsi:nil="true" />
<event xsi:nil="true" />
</events>
<t_address1>string</t_address1>
<t_address2>string</t_address2>
<t_town>string</t_town>
<t_post_code>string</t_post_code>
<enabled>boolean</enabled>
<auto_publish>boolean</auto_publish>
<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>
<aliases>string</aliases>
<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>
<image_byte_array>base64Binary</image_byte_array>
<trade_body>string</trade_body>
</funeral_director>
<charities>
<charity xsi:nil="true" />
<charity xsi:nil="true" />
</charities>
<donations>
<donation xsi:nil="true" />
<donation xsi:nil="true" />
</donations>
<donation_data>
<donations_total>decimal</donations_total>
<donations_online_total>decimal</donations_online_total>
<donations_offline_total>decimal</donations_offline_total>
<gift_aid_total>decimal</gift_aid_total>
<CurrencyDonationsTotal>string</CurrencyDonationsTotal>
<CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
<CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
<CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
</donation_data>
<cropped_photo_path>string</cropped_photo_path>
<DoDMessage>string</DoDMessage>
<isOpen>boolean</isOpen>
<DonationFormURL>string</DonationFormURL>
<PageURL>string</PageURL>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</loadTributeByPageNameResult>
</loadTributeByPageNameResponse>
</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/loadTributeByPageName?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/v2/WebService.asmx">
<Data>
<contact>
<beneficiary_nok_details>boolean</beneficiary_nok_details>
<name>string</name>
<relationship>Husband or Wife or Partner or Father or Mother or Son or Daughter or Brother or Sister or Grandson or Granddaughter or Uncle or Aunt or Cousin or Nephew or Niece or Friend or Other</relationship>
<email>string</email>
<address1>string</address1>
<address2>string</address2>
<town>string</town>
<overseas>boolean</overseas>
<post_code>string</post_code>
</contact>
<id>int</id>
<page_name>string</page_name>
<aliases>string</aliases>
<name>string</name>
<first_name>string</first_name>
<middle_names>string</middle_names>
<last_name>string</last_name>
<qualifications>string</qualifications>
<date_of_birth>dateTime</date_of_birth>
<date_of_death>dateTime</date_of_death>
<message>string</message>
<events>
<event>
<id>int</id>
<t_id>int</t_id>
<date_created>dateTime</date_created>
<date_updated>dateTime</date_updated>
<published>boolean</published>
<type>Service or Committal or Reception</type>
<title>string</title>
<date_time>dateTime</date_time>
<address_prefix>string</address_prefix>
<address>string</address>
<location>string</location>
<notes>string</notes>
<order_of_service_byte_array>base64Binary</order_of_service_byte_array>
<order_of_service_url>string</order_of_service_url>
<webcast>boolean</webcast>
<webcast_url>string</webcast_url>
<webcast_username>string</webcast_username>
<webcast_password>string</webcast_password>
<order_of_service_pdf>string</order_of_service_pdf>
</event>
<event>
<id>int</id>
<t_id>int</t_id>
<date_created>dateTime</date_created>
<date_updated>dateTime</date_updated>
<published>boolean</published>
<type>Service or Committal or Reception</type>
<title>string</title>
<date_time>dateTime</date_time>
<address_prefix>string</address_prefix>
<address>string</address>
<location>string</location>
<notes>string</notes>
<order_of_service_byte_array>base64Binary</order_of_service_byte_array>
<order_of_service_url>string</order_of_service_url>
<webcast>boolean</webcast>
<webcast_url>string</webcast_url>
<webcast_username>string</webcast_username>
<webcast_password>string</webcast_password>
<order_of_service_pdf>string</order_of_service_pdf>
</event>
</events>
<t_address1>string</t_address1>
<t_address2>string</t_address2>
<t_town>string</t_town>
<t_post_code>string</t_post_code>
<enabled>boolean</enabled>
<auto_publish>boolean</auto_publish>
<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>
<aliases>string</aliases>
<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>
<image_byte_array>base64Binary</image_byte_array>
<trade_body>string</trade_body>
</funeral_director>
<charities>
<charity>
<page_name>string</page_name>
<t_id>int</t_id>
<beneficiary_note>string</beneficiary_note>
<donation_data d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DonationFormURL>string</DonationFormURL>
</charity>
<charity>
<page_name>string</page_name>
<t_id>int</t_id>
<beneficiary_note>string</beneficiary_note>
<donation_data d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DonationFormURL>string</DonationFormURL>
</charity>
</charities>
<donations>
<donation>
<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>
</donation>
<donation>
<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>
</donation>
</donations>
<donation_data>
<donations_total>decimal</donations_total>
<donations_online_total>decimal</donations_online_total>
<donations_offline_total>decimal</donations_offline_total>
<gift_aid_total>decimal</gift_aid_total>
<CurrencyDonationsTotal>string</CurrencyDonationsTotal>
<CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
<CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
<CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
</donation_data>
<cropped_photo_path>string</cropped_photo_path>
<DoDMessage>string</DoDMessage>
<isOpen>boolean</isOpen>
<DonationFormURL>string</DonationFormURL>
<PageURL>string</PageURL>
</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/v2/WebService.asmx/loadTributeByPageName 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/v2/WebService.asmx">
<Data>
<contact>
<beneficiary_nok_details>boolean</beneficiary_nok_details>
<name>string</name>
<relationship>Husband or Wife or Partner or Father or Mother or Son or Daughter or Brother or Sister or Grandson or Granddaughter or Uncle or Aunt or Cousin or Nephew or Niece or Friend or Other</relationship>
<email>string</email>
<address1>string</address1>
<address2>string</address2>
<town>string</town>
<overseas>boolean</overseas>
<post_code>string</post_code>
</contact>
<id>int</id>
<page_name>string</page_name>
<aliases>string</aliases>
<name>string</name>
<first_name>string</first_name>
<middle_names>string</middle_names>
<last_name>string</last_name>
<qualifications>string</qualifications>
<date_of_birth>dateTime</date_of_birth>
<date_of_death>dateTime</date_of_death>
<message>string</message>
<events>
<event>
<id>int</id>
<t_id>int</t_id>
<date_created>dateTime</date_created>
<date_updated>dateTime</date_updated>
<published>boolean</published>
<type>Service or Committal or Reception</type>
<title>string</title>
<date_time>dateTime</date_time>
<address_prefix>string</address_prefix>
<address>string</address>
<location>string</location>
<notes>string</notes>
<order_of_service_byte_array>base64Binary</order_of_service_byte_array>
<order_of_service_url>string</order_of_service_url>
<webcast>boolean</webcast>
<webcast_url>string</webcast_url>
<webcast_username>string</webcast_username>
<webcast_password>string</webcast_password>
<order_of_service_pdf>string</order_of_service_pdf>
</event>
<event>
<id>int</id>
<t_id>int</t_id>
<date_created>dateTime</date_created>
<date_updated>dateTime</date_updated>
<published>boolean</published>
<type>Service or Committal or Reception</type>
<title>string</title>
<date_time>dateTime</date_time>
<address_prefix>string</address_prefix>
<address>string</address>
<location>string</location>
<notes>string</notes>
<order_of_service_byte_array>base64Binary</order_of_service_byte_array>
<order_of_service_url>string</order_of_service_url>
<webcast>boolean</webcast>
<webcast_url>string</webcast_url>
<webcast_username>string</webcast_username>
<webcast_password>string</webcast_password>
<order_of_service_pdf>string</order_of_service_pdf>
</event>
</events>
<t_address1>string</t_address1>
<t_address2>string</t_address2>
<t_town>string</t_town>
<t_post_code>string</t_post_code>
<enabled>boolean</enabled>
<auto_publish>boolean</auto_publish>
<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>
<aliases>string</aliases>
<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>
<image_byte_array>base64Binary</image_byte_array>
<trade_body>string</trade_body>
</funeral_director>
<charities>
<charity>
<page_name>string</page_name>
<t_id>int</t_id>
<beneficiary_note>string</beneficiary_note>
<donation_data d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DonationFormURL>string</DonationFormURL>
</charity>
<charity>
<page_name>string</page_name>
<t_id>int</t_id>
<beneficiary_note>string</beneficiary_note>
<donation_data d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<DonationFormURL>string</DonationFormURL>
</charity>
</charities>
<donations>
<donation>
<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>
</donation>
<donation>
<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>
</donation>
</donations>
<donation_data>
<donations_total>decimal</donations_total>
<donations_online_total>decimal</donations_online_total>
<donations_offline_total>decimal</donations_offline_total>
<gift_aid_total>decimal</gift_aid_total>
<CurrencyDonationsTotal>string</CurrencyDonationsTotal>
<CurrencyDonationsOnlineTotal>string</CurrencyDonationsOnlineTotal>
<CurrencyDonationsOfflineTotal>string</CurrencyDonationsOfflineTotal>
<CurrencyGiftAidTotal>string</CurrencyGiftAidTotal>
</donation_data>
<cropped_photo_path>string</cropped_photo_path>
<DoDMessage>string</DoDMessage>
<isOpen>boolean</isOpen>
<DonationFormURL>string</DonationFormURL>
<PageURL>string</PageURL>
</Data>
<Error>
<Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
<InternalMessage>string</InternalMessage>
<FriendlyMessage>string</FriendlyMessage>
</Error>
</ResponseOfTribute>