Types of Data Feeds and Parameters

Below is list of URL and query string parameters that can be used with Events@Duke.

Feed Type

Specifies the type of the feed as either a calendar based list of events (i.e. calendar style) or an aggregate list of events (i.e. list style). The selection of available parameters depends on the feed type.

  • Possible values: setViewPeriod.do, listEvents.do
  • Calendar based list URL example: [http://calendar.duke.edu/cal/main/setViewPeriod.do]
  • Aggregate list URL example: [http://calendar.duke.edu/cal/main/listEvents.do]
  • Required; must be used in conjunction with skinName parameter.

Feed Parameters

The following parameters can be applied to feeds.

Skin Name

Specifies the XSL template for XML processing.

  • Possible values for calendar style: rss, default, feed, feedjs
  • Possible values for list style: rss-agg-list, feed-list
  • Default value: default
  • Query string example value: skinName=feed
  • Required for all feeds

Time Period

Specifies preferred view of the calendar as day, week, or month.

  • Possible values: dayView, weekView, monthView
  • Default value: dayView
  • Query string example value: viewType=weekView
  • Optional
  • Only valid with calendar style feeds

Date

Specifies the desired date of the events list. When using week or month view, the events list will fall within the week or month of the date specified.

  • Possible values: any valid date in the format YYYYMMDD
  • Default value: today
  • Query string example value: date=20080822
  • Optional
  • Only valid with calendar style feeds

Level of Detail

Specifies the level of detail for each event in either summary or detail mode.

  • Possible values: summary, detail
  • Default value: summary
  • Query string example value: setappvar=summaryMode(details)
  • Required for RSS, optional for XML feeds
  • When used with XML feeds this parameter will toggle the display of a "description" XML node and other detailed XML nodes.

Group

Specifies the Duke group sponsoring the events list.

  • Possible values: Any group's system id
  • Default value: All
  • Query string example value: setappvar=group(agrp_example)
  • Optional
  • When skin name is "feed", "feed-list", or "feedjs" multiple groups can be specified: setappvar=group(agrp_example, agrp_example2)

Categories

Specifies one or many categories to filter the events list. Each category is separated by a '~' (tilde).

  • Possible values: Any valid category name
  • Default value: All
  • Query string example value: setappvar=category(Concert/Music~ Dance Performance~ Exhibit~ Masterclass~ Movie/Film~ Reading~ Theater)
  • Optional
  • Only valid with RSS style feeds

Number of Days

Specifies the number of days of events to return.

  • Possible values: 1-90
  • Default value: 7
  • Query string example value: days=20
  • Optional
  • Only valid with list style feeds

Start Date

Specifies the start date for the list of events.

  • Possible values: any valid date in the form of YYYY-MM-DD
  • Default value: Today
  • Query string example: start=2008-08-20
  • Optional
  • Only valid with list style feeds

End Date

Specifies the end date for the list of events.

  • Possible values: any valid date in the form of YYYY-MM-DD
  • Default value: Today
  • Query string example: end=2008-09-20
  • Optional
  • Only valid with list style feeds
  • Can be used with days parameter to choose an end date or the number of days if it is greater