GET EventTribute?SystemAPIKey={SystemAPIKey}&SiteAPIKey={SiteAPIKey}&EventExternalID={EventExternalID}

Returns the processed notification details for a specific event's visual tribute setup by Wesley Media. If the tribute has not yet been setup the response may return successful: false with the message "No tribute information found for this event". PLEASE NOTE: In the test environment, this method will always return an example tribute due to data requiring tribute setup by Wesley Media.

Request Information

URI Parameters

Name	Description	Type	Additional information
SystemAPIKey	API Key provided by Wesley to identify your event management system	string	Required
SiteAPIKey	API Key specific to the site in which your event management system is being used	string	Required
EventExternalID	Your system identifier for the event in which to find tribute details	string	Required

Body Parameters

None.

Response Information

Resource Description

EventTributeResponse

Name	Description	Type	Additional information
Tribute	Tribute details for the event including all setup information, quantities and formatted summary	EventTribute	None.
Successful	False = API Call failed, True = API was called successfully and data passed validation	boolean	None.
ErrorMessage	Contains the description of the error e.g. Invalid API Key	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Tribute": {
    "EventRefID": 1,
    "Images": 1,
    "Minutes": 1,
    "Setup": "sample string 2",
    "Music": "sample string 3",
    "Still": 1,
    "AdditionalStill": 1,
    "SlideshowNoMusic": 1,
    "AdditionalNoMusic": 1,
    "SlideshowWithMusic": 1,
    "AdditionalWithMusic": 1,
    "SlideshowVideo": 1,
    "FamilyVideo": 1,
    "UrgentService": true,
    "EventNo": 1,
    "OrderedBy": "sample string 5",
    "TributeSummary": "sample string 6"
  },
  "Successful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<EventTributeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WesleyAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Successful>true</Successful>
  <Tribute>
    <AdditionalNoMusic>1</AdditionalNoMusic>
    <AdditionalStill>1</AdditionalStill>
    <AdditionalWithMusic>1</AdditionalWithMusic>
    <EventNo>1</EventNo>
    <EventRefID>1</EventRefID>
    <FamilyVideo>1</FamilyVideo>
    <Images>1</Images>
    <Minutes>1</Minutes>
    <Music>sample string 3</Music>
    <OrderedBy>sample string 5</OrderedBy>
    <Setup>sample string 2</Setup>
    <SlideshowNoMusic>1</SlideshowNoMusic>
    <SlideshowVideo>1</SlideshowVideo>
    <SlideshowWithMusic>1</SlideshowWithMusic>
    <Still>1</Still>
    <TributeSummary>sample string 6</TributeSummary>
    <UrgentService>true</UrgentService>
  </Tribute>
</EventTributeResponse>