The list of parameters below represent optional parameters for our Get Events https://aievolution-api.helpdocs.com/events/servicegetevents and Get Event Search Results https://aievolution-api.helpdocs.com/events/servicegeteventsearchresults services.

Parameters:

  • eventIDs: Comma separated numeric values; Used to pull a specific list of events by id.
  • searchText: Text string used to perform a general search of the events. This parameter is used to find matches in the title, description, objectives or speaker names.
  • code: text string to search code field on events.
    • Note: using the code parameter will search for an event at any level (searchEventLevels parameter is ignored entirely).
  • plannerID: Numeric value containing a valid planner
  • activityCode: This is a human readable string representation of the plannerID. It is the planner/activity/conference code that was entered during the activity setup. Use this parameter to filter the events by planner/activity/conference.
  • eventTypeID: Numeric value containing a valid event type
  • categoryID: Numeric value containing a valid category. Use the ‘getEventSearchOptions’ call to obtain a valid list of categories
  • locationID: Numeric value containing a valid location. Use the ‘getEventSearchOptions’ call to obtain a valid list of locations
  • speakerID: Numeric value containing a valid speaker. Use the ‘getEventSearchOptions’ call to obtain the list of possible speakers.
  • startsOnDate: Date value containing a valid date. Use the ‘getEventSearchOptions’ call to obtain a valid list of dates.
  • startsOnTime: Time value in 12 hour format. E.g. 6:30PM
  • statusFlag: Valid values: 1-Active; 0-Inactive; -1-All; Used to indicate if the event is active or inactive. Generally inactive events are events that have been cancelled or removed by the client.
  • publicUseFlag: Valid values: 1=Public; 0=Private; -1=All; Used to determine the types of events to include. Public events are viewable to the general population. Private events are events clients are withholding from the general viewing public
  • approvedFlag: Valid values: 1=Approved; 0=Not Approved; -1=Both; Used to determine the types of events to include. Note that a site setting can be used to use approvedFlag=1 by default. However, passing the parameter via the url will override the site setting parameter.
  • modifiedOnAfter: Valid date string (yyyy-mm-dd HH:mm – 24hour time format); Used to indicate a date to use for only including changes after the supplied date.
  • modifiedOnAfterApplyToAll: Used in conjunction with modifiedOnAfter. When set to 1, this will return events that had changes to any of the following related data: Sub events, itineraries, event credits, category assignments, room assignments, and documents