POST api/Tribute

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FuneralHomeID		integer	Required Range: inclusive between 1 and 10000
TributeID	Use 0 if its a new Tribute	integer	Required
FirstName		string	Required Max length: 50
MiddleName	blank if unknown / none	string	Max length: 50
LastName		string	Required Max length: 60
DateOfBirth	if unknown use 1900-01-01 00:00:00.000	date	Required
DateOfDeath	if unknown use 1800-01-01 00:00:00.000	date	Required
ExpiryAndCommentNotificationEmail		string	Matching regular expression pattern: ^([\w\.\-]+)@([\w\-]+)((\.(\w+))+)$ Max length: 255
FuneralServiceDateTime	if not applicable use 1900-01-01 00:00:00.000	date	Required
FuneralServiceNameOfVenue	blank if unknown / none	string	Max length: 50
FuneralServiceStreetAddress	blank if unknown / none	string	Max length: 100
FuneralServiceSuburb	blank if unknown / none	string	Max length: 50
FuneralServiceCity	blank if unknown / none	string	Max length: 50
TributeText		string	Required
ThemeID	Background Theme, use /api/themes to get list of all themes	integer	Required Range: inclusive between 0 and 20
TestTribute	1=Test Tribute (use fake name and delete Tribute after testing) or 0=Live Tribute	integer	Required Range: inclusive between 0 and 1
LiveStreamEnabled	Allow Request for Live streaming from Tribute 1=True	integer	Range: inclusive between 0 and 1
LiveStreamEmail	The email to request access for live streaming	string	Matching regular expression pattern: ^([\w\.\-]+)@([\w\-]+)((\.(\w+))+)$ Max length: 255
ServiceGoogleMapURL		string	Max length: 255
LiveStreamURL		string	Max length: 255
NotifyEmails		Collection of NotifyEmail	None.
FuneralServiceHasRestrictions	Funeral Service has Attendee Restrictions (1 = There are Restrictions, 0 = No Restrictions (Default) )	integer	Range: inclusive between 0 and 1
FuneralServiceRestrictionsVaccinationRequired	Funeral Service is only for Covid vacinated or with a Medical Exemption Cert. 1 = True)	integer	Range: inclusive between 0 and 1
FuneralServiceRestrictionsUnlimitedAttendees	Funeral Service has Unlimited Attendees (Only applicable for Covid/Medical Exemption Cert required Funeral with No Max Attendees. 1 = True )	integer	Range: inclusive between 0 and 1
FuneralServiceRestrictionsMaxAttendees	Funeral Service has Max Number of Attendees Restriction and not Unlimited Attendees (If Unlimited Attendees use 0)	integer	Range: inclusive between 0 and 1000
FuneralServiceRestrictionsFamiliyReserved	Funeral Service number of spaces reserved for Family (number should be included in the max number of attendees, if Unlimited Attendees use 0)	integer	Range: inclusive between 0 and 1000

Request Formats

application/json, text/json

Sample:

{
  "FuneralHomeID": 1,
  "TributeID": 2,
  "FirstName": "sample string 3",
  "MiddleName": "sample string 4",
  "LastName": "sample string 5",
  "DateOfBirth": "2025-07-01T04:57:49.5233794+12:00",
  "DateOfDeath": "2025-07-01T04:57:49.5263313+12:00",
  "ExpiryAndCommentNotificationEmail": "sample string 8",
  "FuneralServiceDateTime": "2025-07-01T04:57:49.5263313+12:00",
  "FuneralServiceNameOfVenue": "sample string 10",
  "FuneralServiceStreetAddress": "sample string 11",
  "FuneralServiceSuburb": "sample string 12",
  "FuneralServiceCity": "sample string 13",
  "TributeText": "sample string 14",
  "ThemeID": 15,
  "TestTribute": 16,
  "LiveStreamEnabled": 17,
  "LiveStreamEmail": "sample string 18",
  "ServiceGoogleMapURL": "sample string 19",
  "LiveStreamURL": "sample string 20",
  "NotifyEmails": [
    {
      "EmailAddress": "sample string 1"
    },
    {
      "EmailAddress": "sample string 1"
    }
  ],
  "FuneralServiceHasRestrictions": 21,
  "FuneralServiceRestrictionsVaccinationRequired": 22,
  "FuneralServiceRestrictionsUnlimitedAttendees": 23,
  "FuneralServiceRestrictionsMaxAttendees": 24,
  "FuneralServiceRestrictionsFamiliyReserved": 25
}

application/xml, text/xml

Sample:

<TributeMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TributesAPI.Models">
  <DateOfBirth>2025-07-01T04:57:49.5233794+12:00</DateOfBirth>
  <DateOfDeath>2025-07-01T04:57:49.5263313+12:00</DateOfDeath>
  <ExpiryAndCommentNotificationEmail>sample string 8</ExpiryAndCommentNotificationEmail>
  <FirstName>sample string 3</FirstName>
  <FuneralHomeID>1</FuneralHomeID>
  <FuneralServiceCity>sample string 13</FuneralServiceCity>
  <FuneralServiceDateTime>2025-07-01T04:57:49.5263313+12:00</FuneralServiceDateTime>
  <FuneralServiceHasRestrictions>21</FuneralServiceHasRestrictions>
  <FuneralServiceNameOfVenue>sample string 10</FuneralServiceNameOfVenue>
  <FuneralServiceRestrictionsFamiliyReserved>25</FuneralServiceRestrictionsFamiliyReserved>
  <FuneralServiceRestrictionsMaxAttendees>24</FuneralServiceRestrictionsMaxAttendees>
  <FuneralServiceRestrictionsUnlimitedAttendees>23</FuneralServiceRestrictionsUnlimitedAttendees>
  <FuneralServiceRestrictionsVaccinationRequired>22</FuneralServiceRestrictionsVaccinationRequired>
  <FuneralServiceStreetAddress>sample string 11</FuneralServiceStreetAddress>
  <FuneralServiceSuburb>sample string 12</FuneralServiceSuburb>
  <LastName>sample string 5</LastName>
  <LiveStreamEmail>sample string 18</LiveStreamEmail>
  <LiveStreamEnabled>17</LiveStreamEnabled>
  <LiveStreamURL>sample string 20</LiveStreamURL>
  <MiddleName>sample string 4</MiddleName>
  <NotifyEmails>
    <NotifyEmail>
      <EmailAddress>sample string 1</EmailAddress>
    </NotifyEmail>
    <NotifyEmail>
      <EmailAddress>sample string 1</EmailAddress>
    </NotifyEmail>
  </NotifyEmails>
  <ServiceGoogleMapURL>sample string 19</ServiceGoogleMapURL>
  <TestTribute>16</TestTribute>
  <ThemeID>15</ThemeID>
  <TributeID>2</TributeID>
  <TributeText>sample string 14</TributeText>
</TributeMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.