MemoryGivingAPIWebService

MemoryGivingAPIWebService_v2

Click here for a complete list of operations.

createTributePage

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.
* Repeating pairs You can provide multiple charities by repeating the charity_id and beneficiary_note parameters as pairs.
charity_id string Optional Unique ID that identifies each Memory Giving charity. * Mandatory if enabled has a value of true and Funeral Director does not permit non-charity pages.
beneficiary_note string Optional A message from the family to the beneficiary about the allocation of funds. Each beneficiary_note must be paired with a charity_id in the order they are supplied.
name string Mandatory Full name of deceased.
first_name string Mandatory First name of deceased.
middle_names string Optional Middle names of deceased.
last_name string Mandatory Last name of deceased.
qualifications string Optional Qualifications of the deceased.
aliases string Optional Other names that the deceased was known by.
page_name string Optional Automatically calculated from name parameter when creating tribute page.
date_of_birth DateTime Optional (dd MMMM yyyy, dd MMM yyyy)
date_of_death DateTime Mandatory (dd MMMM yyyy, dd MMM yyyy)
dod_msg_format string Optional e.g. Passed away on {0}{1}.
{0} will be replaced with the date_of_death.
{1} will be replaced with the age if date_of_birth is supplied.
message string Optional A message from the family or to the donors.
service_publish bool Optional false If you specify the service_publish parameter with a value of true, you must also specify service_date_time & service_address parameters.
service_title string Optional Funeral Service A custom service title.
service_date_time DateTime Optional * Mandatory if service_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
service_address_prefix string Optional An additional line of the service address. e.g. The name of the chapel where the service is held.
service_address string Optional * Mandatory if service_publish is supplied as true. Address of where the service is held.
service_location string Optional Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from service_address.
service_notes string Optional Miscellaneous information related to the service.
service_webcast bool Optional false If you specify the service_webcast parameter with a value of true, you must also specify the service_webcast_url parameter.
service_webcast_url string Optional The full URL of the service webcast.* Mandatory if service_webcast is supplied as true.
service_webcast_username string Optional The username of the service webcast.
service_webcast_password string Optional The password of the service webcast.
service_order_of_service_byte_array string Optional Base64 encoded string of the pdf file bytes.
service_order_of_service_url string Optional The full URL of an online order or service.
committal_publish bool Optional false If you specify the committal_publish parameter with a value of true, you must also specify the committal_date_time & committal_address parameters.
committal_title string Optional Committal A custom committal title.
committal_date_time DateTime *Optional * Mandatory if committal_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
committal_address_prefix string Optional An additional line of the committal address. e.g. The name of the chapel where the committal is held.
committal_address string Optional * Mandatory if committal_publish is supplied as true. Address of where the committal is held.
committal_location string Optional Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from committal_address.
committal_notes string Optional Miscellaneous information related to the committal.
committal_webcast bool Optional false If you specify the committal_webcast parameter with a value of true, you must also specify the committal_webcast_url parameter.
committal_webcast_url string Optional The full URL of the committal webcast.* Mandatory if committal_webcast is supplied as true.
committal_webcast_username string Optional The username of the committal webcast.
committal_webcast_password string Optional The password of the committal webcast.
reception_publish bool Optional false If you specify the reception_publish parameter with a value of true, you must also specify the reception_date_time & reception_address parameters.
reception_title string Optional Reception A custom reception title.
reception_date_time DateTime Optional * Mandatory if reception_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
reception_address_prefix string Optional An additional line of the reception address. e.g. The name of the room where the reception is held.
reception_address string Optional * Mandatory if reception_publish is supplied as true. Address of where the reception is held.
reception_location string Optional Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from reception_address.
reception_notes string Optional Miscellaneous information related to the reception.
reception_webcast bool Optional false If you specify the reception_webcast parameter with a value of true, you must also specify the reception_webcast_url parameter.
reception_webcast_url string Optional The full URL of the reception webcast.* Mandatory if reception_webcast is supplied as true.
reception_webcast_username string Optional The username of the reception webcast.
reception_webcast_password string Optional The password of the reception webcast.
t_address1 string Optional Deceased address line 1.
t_address2 string Optional Deceased address line 2.
t_town string Optional Deceased address town.
t_post_code string Optional Deceased address post code.
contact_name string Optional Contact / NOK name.
* Mandatory if charity_id supplied.
contact_relationship string Optional Other Contact / NOK relationship - must be one of the following:

* Mandatory if charity_id supplied.
contact_email string Optional Contact / NOK email address.
* Mandatory if charity_id supplied.
beneficiary_nok_details bool Optional false Indicates whether the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
contact_address1 string Optional Contact / NOK address line 1.
* Mandatory if charity_id is supplied & beneficiary_nok_details is true.
contact_address2 string Optional Contact / NOK address line 2.
contact_town string Optional Contact / NOK address town.
* Mandatory if charity_id is supplied & beneficiary_nok_details is true.
contact_overseas bool Optional false Contact / NOK address is overseas.
contact_post_code string Optional Contact / NOK address post code.
* Mandatory if charity_id is supplied, beneficiary_nok_details is true & contact_overseas is false.
enabled bool Mandatory Indicates whether the page is active or not.
base64FileBytes string Optional Base64 encoded string of the image file bytes. If you specify the base64FileBytes parameter, you must also specify the file_name parameter.
file_name string * Optional File name, including extension, of the uploaded image.
* Mandatory if base64FileBytes is supplied.
photo_width int Optional 400 Width in pixels that the source image should be reduced to.
photo_top int Optional 0 Y coordinate of the source image in relation to the crop area.
photo_left int Optional 0 X coordinate of the source image in relation to the crop area.
photo_thumb_width int Optional 50 Width in pixels that the source image should be reduced to.
photo_thumb_top int Optional 0 Y coordinate of the source image in relation to the crop area.
photo_thumb_left int Optional 0 X coordinate of the source image in relation to the crop area.
View Photo Crop Example

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

<?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>
    <createTributePage xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
      <api_key>string</api_key>
    </createTributePage>
  </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>
    <createTributePageResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
      <createTributePageResult>
        <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>
      </createTributePageResult>
    </createTributePageResponse>
  </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>
    <createTributePage xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
      <api_key>string</api_key>
    </createTributePage>
  </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>
    <createTributePageResponse xmlns="http://memorygiving.com/admin/api/v2/WebService.asmx">
      <createTributePageResult>
        <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>
      </createTributePageResult>
    </createTributePageResponse>
  </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/createTributePage?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/createTributePage 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>

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.
* Repeating pairs				You can provide multiple charities by repeating the charity_id and beneficiary_note parameters as pairs.
charity_id	string	Optional		Unique ID that identifies each Memory Giving charity. * Mandatory if enabled has a value of true and Funeral Director does not permit non-charity pages.
beneficiary_note	string	Optional		A message from the family to the beneficiary about the allocation of funds. Each beneficiary_note must be paired with a charity_id in the order they are supplied.
name	string	Mandatory		Full name of deceased.
first_name	string	Mandatory		First name of deceased.
middle_names	string	Optional		Middle names of deceased.
last_name	string	Mandatory		Last name of deceased.
qualifications	string	Optional		Qualifications of the deceased.
aliases	string	Optional		Other names that the deceased was known by.
page_name	string	Optional		Automatically calculated from name parameter when creating tribute page.
date_of_birth	DateTime	Optional		(dd MMMM yyyy, dd MMM yyyy)
date_of_death	DateTime	Mandatory		(dd MMMM yyyy, dd MMM yyyy)
dod_msg_format	string	Optional		e.g. Passed away on {0}{1}. {0} will be replaced with the date_of_death. {1} will be replaced with the age if date_of_birth is supplied.
message	string	Optional		A message from the family or to the donors.
service_publish	bool	Optional	false	If you specify the service_publish parameter with a value of true, you must also specify service_date_time & service_address parameters.
service_title	string	Optional	Funeral Service	A custom service title.
service_date_time	DateTime	Optional		* Mandatory if service_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
service_address_prefix	string	Optional		An additional line of the service address. e.g. The name of the chapel where the service is held.
service_address	string	Optional		* Mandatory if service_publish is supplied as true. Address of where the service is held.
service_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from service_address.
service_notes	string	Optional		Miscellaneous information related to the service.
service_webcast	bool	Optional	false	If you specify the service_webcast parameter with a value of true, you must also specify the service_webcast_url parameter.
service_webcast_url	string	Optional		The full URL of the service webcast.* Mandatory if service_webcast is supplied as true.
service_webcast_username	string	Optional		The username of the service webcast.
service_webcast_password	string	Optional		The password of the service webcast.
service_order_of_service_byte_array	string	Optional		Base64 encoded string of the pdf file bytes.
service_order_of_service_url	string	Optional		The full URL of an online order or service.
committal_publish	bool	Optional	false	If you specify the committal_publish parameter with a value of true, you must also specify the committal_date_time & committal_address parameters.
committal_title	string	Optional	Committal	A custom committal title.
committal_date_time	DateTime	*Optional		* Mandatory if committal_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
committal_address_prefix	string	Optional		An additional line of the committal address. e.g. The name of the chapel where the committal is held.
committal_address	string	Optional		* Mandatory if committal_publish is supplied as true. Address of where the committal is held.
committal_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from committal_address.
committal_notes	string	Optional		Miscellaneous information related to the committal.
committal_webcast	bool	Optional	false	If you specify the committal_webcast parameter with a value of true, you must also specify the committal_webcast_url parameter.
committal_webcast_url	string	Optional		The full URL of the committal webcast.* Mandatory if committal_webcast is supplied as true.
committal_webcast_username	string	Optional		The username of the committal webcast.
committal_webcast_password	string	Optional		The password of the committal webcast.
reception_publish	bool	Optional	false	If you specify the reception_publish parameter with a value of true, you must also specify the reception_date_time & reception_address parameters.
reception_title	string	Optional	Reception	A custom reception title.
reception_date_time	DateTime	Optional		* Mandatory if reception_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
reception_address_prefix	string	Optional		An additional line of the reception address. e.g. The name of the room where the reception is held.
reception_address	string	Optional		* Mandatory if reception_publish is supplied as true. Address of where the reception is held.
reception_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from reception_address.
reception_notes	string	Optional		Miscellaneous information related to the reception.
reception_webcast	bool	Optional	false	If you specify the reception_webcast parameter with a value of true, you must also specify the reception_webcast_url parameter.
reception_webcast_url	string	Optional		The full URL of the reception webcast.* Mandatory if reception_webcast is supplied as true.
reception_webcast_username	string	Optional		The username of the reception webcast.
reception_webcast_password	string	Optional		The password of the reception webcast.
t_address1	string	Optional		Deceased address line 1.
t_address2	string	Optional		Deceased address line 2.
t_town	string	Optional		Deceased address town.
t_post_code	string	Optional		Deceased address post code.
contact_name	string	Optional		Contact / NOK name. * Mandatory if charity_id supplied.
contact_relationship	string	Optional	Other	Contact / NOK relationship - must be one of the following: * Mandatory if charity_id supplied.
contact_email	string	Optional		Contact / NOK email address. * Mandatory if charity_id supplied.
beneficiary_nok_details	bool	Optional	false	Indicates whether the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
contact_address1	string	Optional		Contact / NOK address line 1. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
contact_address2	string	Optional		Contact / NOK address line 2.
contact_town	string	Optional		Contact / NOK address town. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
contact_overseas	bool	Optional	false	Contact / NOK address is overseas.
contact_post_code	string	Optional		Contact / NOK address post code. * Mandatory if charity_id is supplied, beneficiary_nok_details is true & contact_overseas is false.
enabled	bool	Mandatory		Indicates whether the page is active or not.
base64FileBytes	string	Optional		Base64 encoded string of the image file bytes. If you specify the base64FileBytes parameter, you must also specify the file_name parameter.
file_name	string	* Optional		File name, including extension, of the uploaded image. * Mandatory if base64FileBytes is supplied.
photo_width	int	Optional	400	Width in pixels that the source image should be reduced to.
photo_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
photo_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
photo_thumb_width	int	Optional	50	Width in pixels that the source image should be reduced to.
photo_thumb_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
photo_thumb_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
View Photo Crop Example

Parameter	Value
api_key: