Why use widgets rather than XML?
Most people need basically the same types of widgets. So rather than everyone building their own, Web Services does it for them. We have direct access to query the database for events that have changed. In addition, widgets are static content and do not pull data every time a person accesses a web page.
Why limit XML data requests?
XML is generic data that is dynamically pulled; it is not static. There are server costs for us when users pull data, therefore we limit the number of simultaneous web requests. If the limit is reached an HTTP 503 error code is sent along with a message.
Do we provide a way for importing events?
No. The Calendar is intended to be used as a marketing tool, and it is often used by stakeholders who have no marketing background. As such, robust calendar management--choosing appropriate and consistent tags, event types, location and sponsor information, etc.--is essential to the success of events. In other words, we don't want people just dumping their events into the calendar system.
How can we avoid entering events more than once?
We recommend having individuals enter events into our calendar system. Then, pull the events out using the XML web data feeds so that you can integrate them back into your calendar system. Since we ask users for more information than most calendar systems, you have more control over how events appear within your current calendars.
The calendar XML schema can be found here:
https://xml.calendars.illinois.edu/calendars13.xsd
The deprecated calendar XML schema can be found here:
https://xml.calendars.illinois.edu/calendars12.xsd (this is not supported after 9/16/2020)
How to receive notifications of service changes?
We post all updates to the Calendar XML documentation to the CCSP listserv. When changes are made we will push out a new schema and new URLs. These will have a new version number so that users can continue to use the old while the new are available. We try to provide a six-week window from when we push out new changes until we turn off old URLs.
How to access the XML?
In order to access the XML URLs, you have to register your IP address with Web Services. To do this fill out the Contact Us form found at the bottom of the Webtools portal. Ask us to give your IP addresses access to the Calendar XML data.
How do you do specific searching?
Using the "search" tab from the public calendar web interface you will notice that there are many web parameters used when searching.
search
EventType
KEYWORDS
startDate
endDate
Below is an example of searching based on a start date and end date. You will notice that the slash that separates the elements of a date are HTML escaped with %2F. You will also notice that the month and day are always two numbers:
Schema 13
https://xml.calendars.illinois.edu/eventXML13/7.xml?startDate=07%2F01%2F2020&endDate=07%2F23%2F2020
Schema 12 (this is not supported after 9/16/2020)
https://xml.calendars.illinois.edu/eventXML12/7.xml?startDate=07%2F01%2F2020&endDate=07%2F23%2F2020 (this is not supported after 9/16/2020)
Any of these parameters can be added to the web query "/calendar/eventXML/#.xml" in order to filter the results. The web parameter "searchEventType" can be used more than once.
How do you specify date ranges in a web query?
Generating events, like all data processing, has CPU, memory and other types of costs associated with it. So in order to provide reasonable services we only provide up to 100 events per query. The recommended strategy for getting events is to query based on a date range. Most people query all events within a month. If you find that there are less than 100 events then you have the whole month. Else do one query for each week in the month. If you find that any particular week contains 100 queries then do one query for each day within that particular week.
How long will unsupported schemas and URLs be supported?
Unsupported versions of the schema and URLs will continue to work until the next newer version of the schema is released. We never maintain more than one past version of the schema and URLs. We also will not answer any questions related to past versions of the schema or URLs once their support date has been reached.
