EventSearch

get

https://ws.bullseyelocations.com/RestEventSearch.svc/EventSearch

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ClientID

int32

required

ApiKey

string

required

PostalCode

string

Required if you specify city and state

City

string

Required if you specify postal code and state

State

string

2-alpha state code. Required if you specify city and postal code

CountryID

int32

required

set to 1 for US and 2 for Canada.

Latitude

string

Required if you specify Longitude. If you specify a latitude/longitude pair, a radius search will be performed.

Longitude

string

Required if you specify Longitude. If you specify a latitude/longitude pair, a radius search will be performed.

CategoryIds

string

You can specify a comma-delimited list of categories, to limit your search to those categories.

Radius

int32

required

Specify Radius in miles. Retrieves all events that 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.

StartIndex

int32

required

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.

PageSize

int32

required

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.

StartDate

string

StartDate and EndDate allow you to filter the returned events by date range. Either one or the other or both may be specified.

EndDate

string

StartDate and EndDate allow you to filter the returned events by date range. Either one or the other or both may be specified.

SearchTypeOverride

int32

CountryScope

string

Used to access all events regardless of what country they are in.

MatchAllCategories

boolean

This parameter is automatically set to false, but when overridden to true will require that any result be assigned to all categories passed in.

FindNearestForNoResults

boolean

Setting this parameter to "True" will return the single nearest result regardless of the specified radius.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

401401

500500