Skip to main content

Information for Developers

PlanIt Purple provides a variety of ways to export data to external systems, including iCal, JSON, and XML feeds. Web Communications recommends caching event data outside PlanIt Purple, syncing it no more frequently than every hour and no more than every 4-6 hours if using Cascade.

If you are using the Cascade Web Content Management System, an XML feed is the easiest way to include PlanIt Purple events in your site. There are two ways to create a feed:

  1. Click the "Add/Manage Events" button from the PlanIt Purple homepage, sign in, then click "Add a Feed."
  2. Construct a URL of the following format: https://planitpurple.northwestern.edu/xmlfeed?cal=33&days=30

The following are valid querystring parameters for the second method:

Parameter Description
cal Required. Comma-separated list of group IDs or 0 for all calendars.
days Required. Number of days to include. Can be 0 for unlimited.
category Optional. Comma-separated list of category IDs. All events in specified categories are included (in addition to events in all categories for any specified groups).
max Optional. An integer specifying the maxiumum number of events to be included.
archive Optional. Valid values are 0 (default) or 1, which sets start date to 3 years in the past, ignoring the start parameter. When set, days parameter only applies to future events.
start Optional. Must be a valid date in the format mm-dd-yyyy. Events on or after the specified date will be included.
end Optional. Must be a valid date in the format mm-dd-yyyy. Events on or before the specified date will be included.
token Required for private groups. Alphanumeric access code displayed on the Edit Group page. If there are multiple values for cal, comma separate tokens, using an empty string for non-private groups.

XML feeds contain the following elements:

For examples of XSLT formats that can handle these fields, please contact Web Communications.

Updated Sep 3, 2019