Basic Filtering
The URLS's above (once actual tokens and secrets are added) will pull back a weeks worth of event data from the calendar. The parameters below allow for pulling back events matching the exact criteria specified.
- StartRange
-
-
Optional with a default, date (yyyy-mm-dd)If this value is omitted, this filter will default to today.
-
- EndRange
-
-
Optional with a default, date, (yyyy-mm-dd)If this value is omitted, this filter will default to 7 days from today.If this value is before the StartRange, this filter will default to 7 days after the StartRange.The StartRange and EndRange are special in that they work together to find matching data. Events that are taking place anytime during the range supplied will be returned. There is no native method to return events starting after a specific date or coming before a spefic date.The following API request would find all events that are taking place between January 1-23, 2014.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&StartRange=2014-01-01&EndRange=2014-01-23The following API request would find all events that are taking place between today and 7 days from today.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj
-
- Private
-
-
Optional, Y/NIf "Y", only private events will be returned.If "N", only public events will be returned.If omitted, public and private events will be returned.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Private=Yhttp://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Private=N
-
- Highlighted
-
-
Optional, Y/NIf "Y", only highlighted events will be returned.If "N", only non-highlighted events will be returned.If omitted, highlighted and non-highlighted events will be returned.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Highlighted=Yhttp://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Highlighted=N
-
- Keywords
-
-
Optional, TextThis value allows searching event data by a keyword. The event name, description, summary and keywords are included in the search.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Keywords=entertainment
-
- Categories
-
-
Optional, Comma delimited list of GuidsThis value allows for searching for events based on their classification.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Categories=60EAD9BB-067C-460E-89D8-988635AB06D3,D47B0C32-56EE-44E1-8F11-3FC4610C9430
-
- Locations
-
-
Optional, Comma delimited list of GuidsThis value allows for searching for events based on their location.http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Locations=513CB2BB-8741-48AC-AC68-32D37FDC07DD,F1F169ED-0D72-48FE-ABAA-96BAE4F8580C
-