Types of Templates
Templates are incorporated into the response of a WebAPI interface on the basis of use cases. The following table lists the templates that may be defined within Sundial, what they should present, and when they will be incorporated within an interface's response.
| Value | Name | Description / Usage | ||
|---|---|---|---|---|
 |
||||
| autoReminder | Registration | The autoReminder template defines the layout and presentation of the automated reminder email to be sent to those on an event's registration list at a preset time and date if the automated reminder feature has been elected. | ||
|
||||
| cancellationEmail | Registration | Registration Cancellation Email | ||
|
||||
| checkoutCompletionForm | Registration | The checkoutCompletionForm template defines the layout and presentation of an event's ecommerce checkout completion form which confirms the status of a registrant's registration and payment. | ||
|
||||
| checkoutForm | Registration | The checkoutForm template defines the layout and presentation of an event's ecommerce checkout form which prompts for registration payment. | ||
|
||||
| childFooter | Header/Footer | The childFooter template is displayed when when a child object (e.g. a pop-up window) is to be retrieved/opened in response to a request to display the the event attendee list, detailed event information, or the event's registration mechanism/forms. The childFooter template contains all information necessary to close the information that preceded it. If the template is to close an HTML page, it should contain all HTML tags necessary to closing the page. (e.g. </body>,</html>>,etc.) | ||
|
||||
| childHeader | Header/Footer | The childHeader template is displayed when a child object (e.g. a pop-up window) is to be retrieved/opened in response to a request to display the the event attendee list, detailed event information, or the event's registration mechanism/forms. The childHeader template contains all information necessary to preface or frame the information that will follow. If the template is to open an HTML page, it should contain all HTML tags necessary to opening and defining a page. (e.g. <html>,<head>,<title>,<style>,<body>,etc.) | ||
|
||||
| day | Event(s) Display | The day template defines the layout and presentation of event information presented within the day view type of the event retrieval interface. | ||
|
||||
| emailFooter | Header/Footer | The emailFooter template is used when sending HTML formatted emails to registrants of an event. The emailFooter template contains all information necessary to close the body of the email that precedes it. The template should NOT contain the following tags: </body> and </html> | ||
|
||||
| emailHeader | Header/Footer | The emailHeader template is used when sending HTML formatted emails to registrants of an event. The emailHeader template contains all information necessary to preface or frame the body of the email that will follow. The template may define style information within itself of by linking to an accessible css URI. However, it should NOT contain the following HTML tags: <html>, <head>, <title>, and <body> | ||
|
||||
| eventDetail | Event(s) Display | The eventDetail template defines the layout and presentation of detailed event information if requested by a calendar user via the event retrieval interface (e.g. via the code generated by the %Event_Detail_Link% template variable | ||
|
||||
| eventListing | Event(s) Display | The eventListing template defines the layout and presentation of event information listed via the list view type of the event retrieval interface. The eventListing template should be designed to accomodate its repeated publication in response to the retrieval of multiple events to form the body content of the event retrieval interface's response. | ||
|
||||
| footer | Header/Footer | The footer template is displayed when event information is to be presented in the standalone context of the event retrieval interface. The footer template contains all information necessary to close the event information that preceded it. If the template is to close an HTML page, it should contain all HTML tags necessary to closing the page. (e.g. </body>,</html>>,etc.) | ||
|
||||
| header | Header/Footer | The header template is displayed when event information is to be presented in the standalone context of the event retrieval interface. The header template contains all information necessary to preface or frame the event information that will follow. If the template is to open an HTML page, it should contain all HTML tags necessary to opening and defining a page. (e.g. <html>,<head>,<title>,<style>,<body>,etc.) | ||
|
||||
| month | Event(s) Display | The month template defines the layout and presentation of event information presented within the month view type of the event retrieval interface. | ||
|
||||
| noRecords | Event(s) Display | The noRecords template provides body content to be dsiplayed in place of event information should no events be returned by Sundial's event retrieval interface in response to the criteria specified. | ||
|
||||
| offline | E-Commerce | Offline Payment Template | ||
|
||||
| privacy | E-Commerce | Privacy Policy Template | ||
|
||||
| refund | E-Commerce | Refund Policy Template | ||
|
||||
| registerCancel | Registration | Screen presented when a registration cancellation link is followed | ||
|
||||
| registerConfirm | Registration | The Registration Confirmation Screen is presented to users after their registration. It should be used to communicate the registrant's status | ||
|
||||
| registerEmail | Registration | This email is sent when a registrant completes registration for an event. | ||
|
||||
| registerError | Registration | Registration Error | ||
|
||||
| registerStylesheet | Registration | Registration Form Stylesheets allow you to apply custom CSS to registration forms. | ||
|
||||
| registrationConfirm | Registration | The registrationConfirm template defines the layout and presentation of the confirmation of registration email sent to event registrants to confirm the status of their registration. | ||
|
||||
| registrationForm | Registration | The registrationForm template defines the layout and presentation of registration fields on an event's registration form. | ||
|
||||
| sendEventComplete | Send Event | Send Event Complete | ||
|
||||
| sendEventEmail | Send Event | Send Event Email | ||
|
||||
| sendEventError | Send Event | Send Event Error | ||
|
||||
| sendEventForm | Send Event | Send Event Input Form | ||
|
||||
| waitlistEmail | Registration | The waitlistEmail template defines the layout and presentation of the email to be sent to those on an event's registration waitlist when registration slots become available. | ||
|
||||
| week | Event(s) Display | The week template defines the layout and presentation of event information presented within the week view type of the event retrieval interface. | ||
|
||||
| whosComing | Registration | The attendee template defines the layout and presentation of select registrant information to be listed in response to a request for the list of registrants who have elected to publish their information. The attendee template should be designed to accomodate its repeated publication in response to the retrieval of multiple registrants to form the body content of the event retrieval interface's response. | ||
|
||||
| year | Event(s) Display | The year template defines the layout and presentation of event information presented within the year view type of the event retrieval interface. | ||
Template Relationships
The following diagram displays the default relationships that exist between templates when using the event retrieval interface and the template variables available.
Should a specific behavior not offered by available template variables or a combination of available template variables is desired, one may always incorporate an extension of functionality using Sundial's open interfaces.
Revised: March 19, 2009