Back to Event Manager Main Menu

Entity configuration

Events

The events entity will return a list of event data based on the search parameters in the URL. This 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.

Formatting the request

The following URL format must be used in order to create an events API Call.

 

http://api.activecalendar.com/format/events/?token=&secret=

Applying filters

Additional Parameters (Queries) can be specified to target specific types of events. You can filter by the following queries:

• Start Range and End Range: The StartRange and EndRange are special in that they work together to find matching data. Events that are taking place anytime during the range entered will be returned. There is no native method to return events starting after a specific date or coming before a specific date.
  • Query Type: Optional
  • Format: yyyy-mm-dd
  • Default: For Start Date the default is today's date. End Date's default is 7 days after today.
  • Examples
    • The following API request would find all events that are taking place between January 1-23, 2017.
      http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&StartRange=2017-01-01&EndRange=2017-01-23
    • The following API request does not specify and EndRange, and would use the default value. This will result in finding 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
      
• Event Type: This optional query parameter will determine what type or types of events will be returned. Events in Event Manager are created as either Public or Private Events.
  • Query Type: Optional
  • Format: Y (only private events) or N (only public events)
  • Default: both public and private events
  • Example

    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Private=Y

• Featured: This optional value allows searching for events that have been marked as Featured.
  • Query Type: Optional
  • Format: Y (only featured events) or N (only non-featured events)
  • Default: both public and private events
  • Examples
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Highlighted=Y
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Highlighted=N
• Keywords: This value allows searching event data by a keyword. The event name, description, summary and keyword fields are included in the search by keyword.
  • Query Type: Optional
  • Format: Text
  • Example
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Keywords=entertainment
• Categories: This value allows searching for events that are assigned to one or more categories. Please note, specifying multiple categories will perform an "Or" search.
  • Query Type: Optional
  • Format: Comma-delimited list of Guids
  • Example
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Categories=60EAD9BB-067C-460E-89D8-988635AB06D3,D47B0C32-56EE-44E1-8F11-3FC4610C9430
• Locations: This value allows searching for events that are assigned to one or more locations. Please note, specifying multiple locations will perform an "Or" search.
  • Query Type: Optional
  • Format: Comma-delimited list of Guids
  • Example
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&Locations=513CB2BB-8741-48AC-AC68-32D37FDC07DD,F1F169ED-0D72-48FE-ABAA-96BAE4F8580C
• Aggregated Events: This value allows you to control the inclusion or exclusion of events that are displayed on the Calendar site via aggregation owning the token and secret key used in the call.
  • Query Type: Optional
  • Format: When set to "true" aggregated events will be included in the response. When set to "false" aggregated events will be excluded.
  • Default: True (includes aggregated events)
  • Example
    • http://api.activecalendar.com/xml/events/?token=ZDDE...cGI0&secret=OWNT...Z5Nj&aggregated=true

 

Categories

The Categories entity allows for the return of a list of categories currently in use by a Calendar Site, or the addition of categories to a Calendar Site.

 

The following URL format must be used in order to create a categories API Call.

• http://api.activecalendar.com/format/categories/?token=&secret=

Locations

The Locations entity allows for the return a list of Locations currently in use by a Calendar Site, or the addition of a location to a category site.

 

The following URL format must be used in order to create a locations API Call.

• http://api.activecalendar.com/format/locations/?token=&secret=