This method will return a list of events given the search criteria. This call wraps the returned list in a structure that includes the total number of results.
Return Value: RestEventSearchResults
Summary:
This method will return a list of events given the search criteria. This call wraps the returned list in a structure that includes the total number of results.
Specify postal code, city and state (2-alpha state code), or latitude/longitude (degrees). If you specify alatitude/longitude pair, a radius search will be performed. If you specify postal code or city/state, your configured search type will be used.
You can specify a comma-delimited list of categories, to limit your search to those categories.
Specify Radius in miles.
StartDate and EndDate allow you to filter the returned events by date range. Either one or the other or both may be specified.
Results should be retrieved one page at a time. To retrieve the first 25 results, specify StartIndex = 0 and PageSize = 25. To retrieve the next 25 results, specify StartIndex=25, PageSize=25.
CountryID should be set to 1 for US and 2 for Canada. For other country ID's, you can check the result of the GetCountryList method.
The optional parameter SearchTypeOverride can be used to change the inherent search type for a particular country. The inherent Search Type refers to the Search Rules configured for a country on the Bullseye admin site. For example, if the search type for Australia is set to Radius Search, setting the SearchTypeOverride to the value for Country Search will result in all Australian events being returned. The defined search types are:
Radius: 1 - Retrieves all eventsthat fall within the distance defined by the Radius parameter. For the US and the UK, the value of the Radius parameter is interpreted in miles; in all other countries it is considered kilometers. A starting point needs to be defined through a combination of the City, State, PostalCode, Latitude and Longitude parameters.
Country: 4 - Retrieves all eventsthat fall within the country defined by the CountryId parameter.
An example of when to use the SearchTypeOverride parameter is if no results are returned for a country configured for Radius Search. The fallback for that situation would be to have a second call with SearchTypeOverride set to Country that would return all locations for that country.
The optional parameter CountryScope is used to access all events regardless of what country they are in.The locations can be filtered by Category if that parameter have been provided.
For search requests which require events to match all of the categories input, the MatchAllCategories optional parameter can be used. This parameter is automatically set to false, but when overridden to true will require that any result be assigned to all categories passed in.