Home » Categories » SignUp » Widgets and More

SignUp - Events XML Feed URL Variables

You can create custom RSS or XML feeds in SignUp.

To build your feed, take your base URL:

https://[Your URL]/signupadmin/eventsxml.aspx?dm=xml&nd=30&kw=test

Everything before .aspx is your base feed. To build a feed, add a ? then dm= to set up what kind of feed you are building.
 
Note: You will want to utilize https:// secure access when utilizing your feed in external utilities or importing tools. 

Note: prior to the August 2016 release of SignUp, URLs used the format https://[Your URL]/signup/eventsxml.aspx. Those URLs will redirect to the new format, but we encourage you to update your links to reflect the new format instead of relying on the redirects. Some users may experience issues with XML feeds or widgets not loading because of the redirects. If you encounter issues where your XML feed or widget is not functioning properly, update the feed URL to reflect the new format.

Other switches are as follow.
  • Display Mode - dm=
    • ical, rss, rss2, xml, exml or html
  • Number of Days - nd=
    • 30 or any positive integer value
    • overrides "df=calendar" switch and forces list view
    • "nd=0" returns today's events, "nd=1" returns today's and tomorrow's dates, etc.

  • Date Offset - do=
    • any integer value - accepts positive and negative values
    • offsets what the nd= switch uses as "today"
    • example: do=7&nd=7 returns a week's worth of events starting with events 7 days from now
    • example: do=-30&nd=60 returns 60 days worth of events: the last 30 days and the next 30 days
  • Keyword - kw=
    • any single word or phrase - keyword searches on Description, Title, Tags, and Presenter if a specific presenter is not specified.
  • Date Start - startDate, or ds=
    • A date value in YYYY/MM/DD format.
    • on list view, the events shown start at this date.
  • Date End - endDate, or de=
    • A date value in YYYY/MM/DD format.
    • on list view, the events shown start at this date.
    • this doesn't do anything on calendar view.
  • Presenter - ps=
    • any name, first, last or combined, of a desired presenter.
  • Featured Events - fe=
    • 1 - This displays featured events only.
  • Ongoing Events - ongoing=
    • The feed's default behavior is to not display ongoing events.
    • Add this switch and set it to 1 to display ongoing events.
  • Specific Locations (branches) - lib=
    • 1 for single, where 1 is the library ID.
    • 0,999,1003,1009,1016 for multiple, where these numbers are the library IDs. No spaces.
    • all indicates "all branches" (i.e. system-wide would be lib=all)
    • Branch IDs start in the 1000s as show above. Your branch IDs may vary.
  • Specific Spaces (rooms) - loc=
    • 1 for single, where 1 is the room ID.
    • 1,2,4,6,23 for multiple, where these numbers are the room IDs. No spaces.
  • Specific Age Groups - ag=
    • 1 for single, where 1 is the age group ID.
    • 1,3,5,8,13 for multiple, where these numbers are the age group IDs. No spaces.
  • Specific Event Types - et=
    • 1 for single, where 1 is the event type ID.
    • 3,1,4,15,92 for multiple, where these numbers are the event type IDs. No spaces.
  • Start count - startcount=
    • What item we want to start on - for paging a resultset.
  • Result limit - limit=
    • How many results come back - to limit the amount we get.
  • Specific Events - eventID=
    • 123 for event # 123
  • Private Events - private=
    • 0 = [Default] Only shows public events.
    • 1 = shows both public & private events.
    • 2 = shows only private events.
    • A private event is an event that is either created on a private branch or has a private event type.

  • Events Occurring Prior to "Now" - alltime=
    • 0 = [Default] Does not display events from today which occurred prior to the time of accessing the feed
    • 1 = Displays events from today which occurred prior to the time of accessing the feed

  • Spaces Reservations - roominfo=
    • = include Spaces Reservations.
    • This will work even with the "Spaces Reservation" event type set to "Private."
    • Cannot be used when using the EXML display mode.

 

Custom Fields
  • Applicable To: All Users
  • Attachments: No
  • Summary: Construct XML or RSS feeds, among other types, from SignUp.
2.5 (4)
Article Rating (4 Votes)
Rate this article
  • Icon PDFExport to PDF
  • Icon MS-WordExport to MS Word
Attachments Attachments
There are no attachments for this article.
Comments (2) Comments
Comment by Evanced Support on Mon, May 13th, 2013 at 11:42 AM
http://yourlibrary.evanced.info/signup/EventsXml.aspx?dm=rss2is the base url
Comment by Beth Hatch on Wed, May 1st, 2013 at 4:18 PM
Do I need to create an XML document and upload it to our server or can I just use the base URL to create the feed? I tried imputing our URL followed by ?dm=rss and entering it into a reader and it states that "no valid feeds could be found"
Related Articles
SignUp API
Viewed 3132 times since Wed, Jul 8, 2015
SignUp Aggregate Widget
Viewed 2728 times since Fri, May 9, 2014
SignUp TinyCal Widget
Viewed 4492 times since Fri, Aug 16, 2013
SignUp Calendar Page URL Variables
Viewed 28576 times since Wed, Oct 17, 2012
SignUp Community Event Form Widget
Viewed 10274 times since Mon, Sep 8, 2014
Signup Event List Widget
Viewed 37885 times since Tue, Jul 23, 2013