MemoryGivingAPIWebService Web Service

MemoryGivingAPIWebService

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.
charity_ids string Optional Comma separated charity IDs. * Mandatory if Funeral Director field page_beneficiary_optional has a value of false.
name string Mandatory Full name of 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.
sex string Mandatory Sex of deceased.
Must be one of the following:
* Currently Optional to allow integration of new field.
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 eg. 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.
facebook_link string Optional Page name of a tribute page set up on facebook.
message string Optional A message from the family or to the donors.
beneficiary_note string Optional A message from the family to the beneficiary about the allocation of funds.
service_display bool Optional false If you specify a service_display parameter with a value of true, you must also specify service_date_time & service_address parameters.
service_date_time DateTime Optional * Mandatory if service_display is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
service_chapel string Optional Name of the chapel where the service is held.
service_address string Optional * Mandatory if service_display 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 funeral.
committal_display bool Optional false If you specify a committal_display parameter with a value of true, you must also specify committal_address parameters.
committal_address string Optional * Mandatory if service_display & committal_display are 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.
reception_display bool Optional false If you specify a reception_display parameter with a value of true, you must also specify reception_date_time & reception_address parameters.
reception_date_time DateTime Optional * Mandatory if service_display & reception_display are supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
reception_address string Optional * Mandatory if service_display & reception_display are 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.
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 * Mandatory if charity_id supplied. Contact / NOK name.
contact_relationship string Optional Other * Mandatory if charity_id supplied. Contact / NOK relationship - must be one of the following:
contact_email string Optional * Mandatory if charity_id supplied. Contact / NOK email address.
contact_address1 string Optional * Mandatory if charity_id supplied. Contact / NOK address line 1.
contact_address2 string Optional Contact / NOK address line 2.
contact_town string Optional * Mandatory if charity_id supplied. Contact / NOK address town.
contact_overseas bool Optional false Contact / NOK address is overseas.
contact_post_code string Optional * Mandatory if charity_id supplied & contact_overseas is false. Contact / NOK address post code.
beneficiary_nok_details bool Optional false Indicates whether or not the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
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 a base64FileBytes parameter, you must also specify a file_name parameter.
file_name string Optional File name, including extension, of the uploaded image.
photo_width int Optional 200 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/WebService.asmx HTTP/1.1
Host: www.memorygiving.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://memorygiving.com/admin/api/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/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/WebService.asmx">
      <createTributePageResult>
        <Data>
          <id>int</id>
          <page_name>string</page_name>
          <aliases>string</aliases>
          <fd_id>int</fd_id>
          <charity_id>int</charity_id>
          <sex>Male or Female</sex>
          <name>string</name>
          <age>int</age>
          <age_unit>Years or Months or Days</age_unit>
          <image_byte_array>base64Binary</image_byte_array>
          <colour>int</colour>
          <date_of_birth>dateTime</date_of_birth>
          <date_of_death>dateTime</date_of_death>
          <facebook_link>string</facebook_link>
          <message>string</message>
          <service_display>boolean</service_display>
          <service_title>string</service_title>
          <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>
          <order_of_service_byte_array>base64Binary</order_of_service_byte_array>
          <order_of_service_url>string</order_of_service_url>
          <webcast_display>boolean</webcast_display>
          <webcast_url>string</webcast_url>
          <webcast_username>string</webcast_username>
          <webcast_password>string</webcast_password>
          <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>
          <beneficiary_note>string</beneficiary_note>
          <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>
            <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>
          <charity>
            <id>int</id>
            <charity_name>string</charity_name>
            <aliases>string</aliases>
            <is_charity>boolean</is_charity>
            <charity_number>string</charity_number>
            <description>string</description>
            <web>string</web>
            <logo_path>string</logo_path>
            <image_byte_array>base64Binary</image_byte_array>
            <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>
          <DoDMessage>string</DoDMessage>
          <order_of_service_pdf>string</order_of_service_pdf>
          <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>
      </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/WebService.asmx HTTP/1.1
Host: www.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/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/WebService.asmx">
      <createTributePageResult>
        <Data>
          <id>int</id>
          <page_name>string</page_name>
          <aliases>string</aliases>
          <fd_id>int</fd_id>
          <charity_id>int</charity_id>
          <sex>Male or Female</sex>
          <name>string</name>
          <age>int</age>
          <age_unit>Years or Months or Days</age_unit>
          <image_byte_array>base64Binary</image_byte_array>
          <colour>int</colour>
          <date_of_birth>dateTime</date_of_birth>
          <date_of_death>dateTime</date_of_death>
          <facebook_link>string</facebook_link>
          <message>string</message>
          <service_display>boolean</service_display>
          <service_title>string</service_title>
          <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>
          <order_of_service_byte_array>base64Binary</order_of_service_byte_array>
          <order_of_service_url>string</order_of_service_url>
          <webcast_display>boolean</webcast_display>
          <webcast_url>string</webcast_url>
          <webcast_username>string</webcast_username>
          <webcast_password>string</webcast_password>
          <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>
          <beneficiary_note>string</beneficiary_note>
          <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>
            <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>
          <charity>
            <id>int</id>
            <charity_name>string</charity_name>
            <aliases>string</aliases>
            <is_charity>boolean</is_charity>
            <charity_number>string</charity_number>
            <description>string</description>
            <web>string</web>
            <logo_path>string</logo_path>
            <image_byte_array>base64Binary</image_byte_array>
            <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>
          <DoDMessage>string</DoDMessage>
          <order_of_service_pdf>string</order_of_service_pdf>
          <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>
      </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/WebService.asmx/createTributePage?api_key=string HTTP/1.1
Host: www.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>
    <sex>Male or Female</sex>
    <name>string</name>
    <age>int</age>
    <age_unit>Years or Months or Days</age_unit>
    <image_byte_array>base64Binary</image_byte_array>
    <colour>int</colour>
    <date_of_birth>dateTime</date_of_birth>
    <date_of_death>dateTime</date_of_death>
    <facebook_link>string</facebook_link>
    <message>string</message>
    <service_display>boolean</service_display>
    <service_title>string</service_title>
    <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>
    <order_of_service_byte_array>base64Binary</order_of_service_byte_array>
    <order_of_service_url>string</order_of_service_url>
    <webcast_display>boolean</webcast_display>
    <webcast_url>string</webcast_url>
    <webcast_username>string</webcast_username>
    <webcast_password>string</webcast_password>
    <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>
    <beneficiary_note>string</beneficiary_note>
    <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>
      <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>
    <charity>
      <id>int</id>
      <charity_name>string</charity_name>
      <aliases>string</aliases>
      <is_charity>boolean</is_charity>
      <charity_number>string</charity_number>
      <description>string</description>
      <web>string</web>
      <logo_path>string</logo_path>
      <image_byte_array>base64Binary</image_byte_array>
      <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>
    <DoDMessage>string</DoDMessage>
    <order_of_service_pdf>string</order_of_service_pdf>
    <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/createTributePage HTTP/1.1
Host: www.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>
    <sex>Male or Female</sex>
    <name>string</name>
    <age>int</age>
    <age_unit>Years or Months or Days</age_unit>
    <image_byte_array>base64Binary</image_byte_array>
    <colour>int</colour>
    <date_of_birth>dateTime</date_of_birth>
    <date_of_death>dateTime</date_of_death>
    <facebook_link>string</facebook_link>
    <message>string</message>
    <service_display>boolean</service_display>
    <service_title>string</service_title>
    <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>
    <order_of_service_byte_array>base64Binary</order_of_service_byte_array>
    <order_of_service_url>string</order_of_service_url>
    <webcast_display>boolean</webcast_display>
    <webcast_url>string</webcast_url>
    <webcast_username>string</webcast_username>
    <webcast_password>string</webcast_password>
    <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>
    <beneficiary_note>string</beneficiary_note>
    <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>
      <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>
    <charity>
      <id>int</id>
      <charity_name>string</charity_name>
      <aliases>string</aliases>
      <is_charity>boolean</is_charity>
      <charity_number>string</charity_number>
      <description>string</description>
      <web>string</web>
      <logo_path>string</logo_path>
      <image_byte_array>base64Binary</image_byte_array>
      <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>
    <DoDMessage>string</DoDMessage>
    <order_of_service_pdf>string</order_of_service_pdf>
    <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>

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.
charity_ids	string	Optional		Comma separated charity IDs. * Mandatory if Funeral Director field page_beneficiary_optional has a value of false.
name	string	Mandatory		Full name of 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.
sex	string	Mandatory		Sex of deceased. Must be one of the following: * Currently Optional to allow integration of new field.
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		eg. 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.
facebook_link	string	Optional		Page name of a tribute page set up on facebook.
message	string	Optional		A message from the family or to the donors.
beneficiary_note	string	Optional		A message from the family to the beneficiary about the allocation of funds.
service_display	bool	Optional	false	If you specify a service_display parameter with a value of true, you must also specify service_date_time & service_address parameters.
service_date_time	DateTime	Optional		* Mandatory if service_display is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
service_chapel	string	Optional		Name of the chapel where the service is held.
service_address	string	Optional		* Mandatory if service_display 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 funeral.
committal_display	bool	Optional	false	If you specify a committal_display parameter with a value of true, you must also specify committal_address parameters.
committal_address	string	Optional		* Mandatory if service_display & committal_display are 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.
reception_display	bool	Optional	false	If you specify a reception_display parameter with a value of true, you must also specify reception_date_time & reception_address parameters.
reception_date_time	DateTime	Optional		* Mandatory if service_display & reception_display are supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
reception_address	string	Optional		* Mandatory if service_display & reception_display are 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.
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		* Mandatory if charity_id supplied. Contact / NOK name.
contact_relationship	string	Optional	Other	* Mandatory if charity_id supplied. Contact / NOK relationship - must be one of the following:
contact_email	string	Optional		* Mandatory if charity_id supplied. Contact / NOK email address.
contact_address1	string	Optional		* Mandatory if charity_id supplied. Contact / NOK address line 1.
contact_address2	string	Optional		Contact / NOK address line 2.
contact_town	string	Optional		* Mandatory if charity_id supplied. Contact / NOK address town.
contact_overseas	bool	Optional	false	Contact / NOK address is overseas.
contact_post_code	string	Optional		* Mandatory if charity_id supplied & contact_overseas is false. Contact / NOK address post code.
beneficiary_nok_details	bool	Optional	false	Indicates whether or not the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
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 a base64FileBytes parameter, you must also specify a file_name parameter.
file_name	string	Optional		File name, including extension, of the uploaded image.
photo_width	int	Optional	200	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: