ShareURL - Manually Editing Your ShareURL

This document explains the parameters available when manually editing a ShareURL. The information below is intended for more advanced users, including web developers.


By default, ShareURL will display calendar data only for "Today" in HTML format. ShareURL defines "Today" as the day you visit the ShareURL, not the day the ShareURL was created.

  • ShareURLs are formatted in the following way:

    • All ShareURLs start with the same base:

      https://calendar.wisc.edu/share/u/

    • Traditional ShareURLs include the base URL followed by a random string of characters:

      https://calendar.wisc.edu/share/u/0123456789/

    • Public ShareURLs include the base URL followed by an email address:

      https://calendar.wisc.edu/share/u/bbadger@wisc.edu/

  • You can make modifications to the calendar output by manually editing the following attributes in your ShareURL:

  • If you want to use multiple attributes in a single ShareURL, see:

You can find additional ways to customize your ShareURL output within the ShareURL interface.


Date Range

ShareURL allows you to specify a date range in two different ways:

  • Choose a relative date range

    • ShareURL allows you choose a date range relative to today's date. For example:

      • 7 days in the past to 14 days in the future:

        https://calendar.wisc.edu/share/u/0123456789/dr(-7,14)

      • 14 days in the past to 7 days in the future:

        https://calendar.wisc.edu/share/u/0123456789/dr(-14,7)

      • 10 days in the future to 100 days in the future:

        https://calendar.wisc.edu/share/u/0123456789/dr(10,100)

      • 90 days in the past to 90 days in the future:

        https://calendar.wisc.edu/share/u/0123456789/dr(-90,90)

      • Today to 180 days in the future:

        https://calendar.wisc.edu/share/u/0123456789/dr(0,180)

    • The date range can include a maximum of 180 days. Larger date ranges will be truncated after the first day + 180 days.
  • Specify a start and end date

    • ShareURL allows you to select a specific start and end date for the calendar data displayed in your ShareURL. For example:

      • August 1, 2012

        https://calendar.wisc.edu/share/u/0123456789?start=2012-08-01

      • From August 1, 2012 to August 31, 2012

        https://calendar.wisc.edu/share/u/0123456789?start=2012-08-01&end=2012-08-31

      • From January 1, 2012 to December 31, 2013

        https://calendar.wisc.edu/share/u/0123456789?start=2012-01-01&end=2012-12-31

      • From February 7, 2013 to March 15, 2013

        https://calendar.wisc.edu/share/u/0123456789?start=2013-02-07&end=2013-03-15

    • These parameters will be ignored if the value of the format is invalid or if the URL includes a date range in the dr(X,Y) format. If start is defined, but end is before start, the end value will be ignored.

Each ShareURL should only use one format to specify date range.

Back to the Top


Output Formats

There are several different output options available for ShareURL. With the exception of the asText parameter, format parameters cannot be combined:

  • HTML

    • This is the default output format for ShareURL. Calendar data will be displayed in HTML format if you don't make any changes to your ShareURL. For example:

      https://calendar.wisc.edu/share/u/0123456789/

    • You can enter an HTML-formatted ShareURL directly into your web browser.

  • iCalendar

    • To create a ShareURL that produces iCalendar-formatted data, you will need to include the ical parameter in your URL. For example:

      https://calendar.wisc.edu/share/u/0123456789?ical

    • The iCalendar format allows you to view your ShareURL in calendar clients such as Microsoft Outlook, Apple Calendar, or Mozilla Thunderbird with the Lightning add-on.
      • As Text

        • You can create a text version of the iCalendar output that is viewable in a web browser using the asText parameter:

          https://calendar.wisc.edu/share/u/0123456789?ical&asText

        • The asText parameter on its own does not trigger iCalendar output, so this parameter must be used in conjunction with the ical parameter. This is helpful for developers interested in the iCalendar output that want to quickly view the content in the browser.
  • RSS

    • To create a ShareURL that produces RSS-formatted data, include the rss parameter in your URL. For example:

      https://calendar.wisc.edu/share/u/0123456789?rss

    • The RSS format allows you to view your ShareURL in a News (RSS) Reader.

  • JSON

    • To create a share URL that produces JSON-formatted data, include the json parameter in your URL. For example:

      https://calendar.wisc.edu/share/u/0123456789?json

    • For more information about the JSON standard, please see http://json.org/

  • Free/Busy

    • If you want to user your ShareURL to publish free/busy information with Microsoft Outlook, you can do this by using the vfb parameter. For example:

      https://calendar.wisc.edu/share/u/0123456789?vfb

    • For more information on publishing your free/busy information using Microsoft Outlook, click here.

Back to the Top


Filters

ShareURL allows you to filter your calendar data using four different parameters:

  • Personal

    • A ShareURL with a personal filter will return only "personal" events, i.e. events you organized with no attendees. For example:

      https://calendar.wisc.edu/share/u/0123456789?personal

    • This parameter cannot be combined with organizing or attending. It can be used in conjunction with uw-support-date.
  • Organizing

    • A ShareURL with an organizing filter will return only events where the ShareURL's owner is the organizer. For example:

      https://calendar.wisc.edu/share/u/0123456789?organizing

    • This parameter cannot be combined with personal or attending. It can be used in conjunction with uw-support-date.
  • Attending

    • A ShareURL with an attending filter will return only events where the ShareURL's owner is an attendee, not the organizer. For example:

      https://calendar.wisc.edu/share/u/0123456789?attending

    • This parameter cannot be combined with personal or organizing. It can be used in conjunction with uw-support-date.
  • uw-support-rdate (Advanced Users)

    • The uw-support-date filter will display only recurring meetings that use a property called "RDATE". Recurring events migrated from the previous Oracle Calendar system used the RDATE property to signal recurrence and many meetings that use this property do not display properly in many desktop clients. This filter allows you to display only RDATE meetings, which would most likely be missing in many desktop clients. To use the uw-support-date filter, structure your URL as follows:

      https://calendar.wisc.edu/share/u/0123456789?uw-support-date

    • The uw-support-date parameter can be combined with the personal, organizing, or attending parameters.

Back to the Top


Clients (Advanced Users)

ShareURL looks at the User-Agent header of the request, and some times automatically enables some of the compatibility options for you if the WiscMail team has identified support issues that can be resolved as such. If you are a developer interested in consuming the iCalendar data, it may be helpful to view the result of this automatic client detection, generally in conjunction with the asText parameter.
These options have no effect with any other display format other than iCalendar.

  • Google Calendar

    • The client=google parameter automatically selects the best output options for use in Google Calendar:

      https://calendar.wisc.edu/share/u/0123456789?ical&client=google

  • Apple Calendar/iCal

    • The client=apple parameter automatically selects the best iCalendaroptions for use in Apple Calendar/iCal:

      https://calendar.wisc.edu/share/u/0123456789?ical&client=apple

  • Mozilla Thunderbird with Lightning

    • The client=mozilla parameter automatically selects the best output options for use in Mozilla Thunderbird with the Lightning add-on:

      https://calendar.wisc.edu/share/u/0123456789?ical&client=mozilla

Using the client parameter is recommended only for more advanced users; it is NOT required when configuring any of these clients for normal use.

Back to the Top


Compatibility Options (Advanced Users)

The compat parameter triggers different iCalendar data conversions known to help improve compatibility with iCalendar clients. These options have no effect with any other display format other than iCalendar.

  • compat=kr

    • ShareURL removes recurrence properties from all events by default. This allows ShareURL output for recurring events to display correctly in many clients that would otherwise encounter problems. If you are confident that your client will not encounter problems with recurrence properties, you can select compat=kr and ShareURL will preserve original recurrence properties on all events.

      https://calendar.wisc.edu/share/u/0123456789?ical&compat=kr

  • compat=br

    • The compat=br value is only valid if used with compat=kr. When included alongside compat=kr, the compat=br value will remove all RECURRENCE-ID properties and append their values to the UID of the event.

      https://calendar.wisc.edu/share/u/0123456789?ical&compat=kr&compat=br

  • compat=cc

    • The cc value can be used in conjunction with other compatibility options or independently by adding compat=cc. This value converts all events from all classes to Public.

      https://calendar.wisc.edu/share/u/0123456789?ical&compat=cc

Using the compat parameter is recommended only for more advanced users.

Back to the Top


Combining Multiple Query Parameters

All the parameters in this document can be combined unless otherwise noted.

Path Syntax

  • As mentioned previously, all start with the standard base:

    • For a Traditional ShareURL:

      https://calendar.wisc.edu/share/u/0123456789/

    • For a Public ShareURL:

      https://calendar.wisc.edu/share/u/bbadger@wisc.edu/

  • If a date range is specified in the /dr(X,Y) format, this comes next.

    • For 7 days in the past to 7 days in the future:

      https://calendar.wisc.edu/share/u/0123456789/dr(-7,7)

  • If you want to include a query parameter in your ShareURL, this will come after the base URL unless you have specified a date range using the /dr(X,Y). In this case, the query parameter will come after the date range. The first query parameter is always preceded by a question mark. For example:

    • iCal Format

      https://calendar.wisc.edu/share/u/0123456789?ical

    • iCal Format for 7 days in the past to 7 days in the future

      https://calendar.wisc.edu/share/u/0123456789/dr(-7,7)?ical

    The trailing slash, "/", should not be included prior to the "?".

  • If you want to include multiple query parameters, additional query parameters should be separated by an "&". Only the first query parameter should include the "?". For example:

    • iCal Format, Personal Events only

      https://calendar.wisc.edu/share/u/0123456789?ical&personal

    • iCal Format, Personal Events only, Google Compatibility Option

      https://calendar.wisc.edu/share/u/0123456789?ical&personal&client=google

    • iCal Format for 7 days in the past to 7 days in the future, Personal Events only

      https://calendar.wisc.edu/share/u/0123456789/dr(-7,7)?ical&personal

  • There is not a limit to the number of query parameters that can be combined, as long as all are compatible.

Back to the Top


See Also:




Keywords:calendars calendaring shares shared sharing personal attending ical options data output recurring meetings events date range free busy organizer organized   Doc ID:13322
Owner:Ara M.Group:ShareURL
Created:2010-02-15 19:00 CDTUpdated:2015-12-15 12:14 CDT
Sites:DoIT Help Desk, DoIT Staff, Office 365, ShareURL, WiscCal, WiscMail
Feedback:  8   11