Published calendars automatically include the following feeds that can be used for calendar subscriptions or custom publishing of events.
The topics describes how to build custom feed URLs that override the default feed settings to return specific event information in a calendar feed.
Note The default settings for feeds can be customized through the Publishing Control Panel. Learn more.
To add the query strings, at the end of the default URL for the feed, add a question mark (?) to begin the first parameter, and use an ampersand (&) to combine parameters. For example:
The following table lists the feed-specific parameters you can use to customize an RSS, Atom, iCal, CSV, or JSON feed.
| Parameter | How to use it |
|---|---|
| startdate | Specify a start date. If not specified, uses the current date. Date format is yyyymmdd, for example, 20211205 for 5 Dec. 2021.
Note Formerly the date parameter was used to specify the start date. The date parameter is still supported for the time being, but for new feeds, please use startdate instead. |
| enddate | Specify an end date using the same date format as for startdate above. If not specified, all future events are included in the feed. |
| months | Number of calendar months to retrieve. Use months=0 to retrieve one day only. If excluded, the default setting is six months. |
| weeks | Number of calendar weeks to retrieve. |
| days | Number of days to retrieve (frequently used with the startdate parameter). |
| previousweeks | Number of weeks previous to the specified date to retrieve. If previousweeks is excluded, the feed will include two weeks' worth of events previous to the specified date (or the current date if date is not specified). |
| eventid | Specify an event ID to filter the feed to include only that single event. |
| html | If you added HTML formatting to the event Notes and other multi-line text custom fields, this parameter controls whether or not to include that formatting in the event data. Values are 1 for Yes and 0 for No.
You can override the default Yes setting by adding html=0 to a feed URL. Use this approach if you feed events to Twitter and other services that do not support HTML tags. |
| customnotes | Most calendar programs, including Microsoft Office Outlook, that read the Trumba iCal feed do not recognize the feed's custom field data. You can use this parameter to include the custom field data at the top of the Description field.
Values are 1 (Yes, include fields in Description) and 0 (No, do not include fields in Description). You can override the default No setting by adding customnotes=1 to a feed URL. |
| xcal | Add xcal=1 to an RSS feed to include xCal-namespace data. Supported only by RSS. |
| filterview | Filter feed contents by a pre-defined filter view. |
| filter1 filter2 filter3 | The values for the first, second, and/or third filters (when your calendar uses one or more filters). |
| search | Display events that contain search terms. |
| lat | Display events at or within a specific radius of a location identified by a latitude value.
Note Must be used with |
| lon | Display events at or within a specific radius of a location identified by a longitude value. Note Must be used with |
| radius | Identifies the distance away from a specific latitude and longitude location that an event can occur and still be displayed. Note Must be used with |
| mixin or mixout | The default mix-in state. |
| zone | Set the time zone using the index number for the zone you want to view. |
Time periods are based on calendar weeks and months. For example, if you specify a date and a number of months, the information returned will start from the first of the month specified in the date. Likewise, information returned for weeks is determined by the week start day in the calendar settings. Usually weeks are set to start on Sunday or Monday.
The default base URL for a feed is always your calendar's address on the Trumba Connect hosted server, with the appropriate extension appended to it.
Trumba Connect makes your published calendar feeds available in two locations:
The information available in a feed depends on which URL you use.
Use the xcal URL parameter on the RSS feed to enable access to the calendar xCal data. If xcal=1, the feed will include the following xCal tags for basic data that applies to the calendar or to each event.
| Tag | Applies to |
|---|---|
| xCal:prodid | calendar |
| xCal:version | calendar |
| xCal:method | calendar |
| xCal:summary | event |
| xCal:location | event |
| xCal:dtstart | event |
| xCal:duration | event |
| xCal:x-microsoft-cdo-alldayevent | event |
| xCal:description | event |
| xCal:uid | event |
For example, to the following default event information:
<item>
|
The following additional information appears:
<xCal:summary>Massenet's Manon</xCal:summary>
|
And the following calendar tags appear a the top of the feed.
<xCal:prodid>
-//Trumba Corporation//Trumba Connect Services 0.11.1402//EN
</xCal:prodid>
<xCal:version>2.0</xCal:version>
<xCal:method>PUBLISH</xCal:method>
<xCal:calscale>GREGORIAN</xCal:calscale>
|
