DoSearch2

get

https://ws.bullseyelocations.com/restsearch.svc/dosearch2

This method will return a list of locations, given search criteria. This call wraps the returned list in a structure that includes the total number of results. Default sorting and search type are configured in the admin under search rules.

**Return Value: ** RestSearchResults

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ClientID

int32

required

ApiKey

string

required

PostalCode

string

City

string

State

string

CountryID

int32

required

Required for all searches that include country. If countryID is not provided and latidude/longitude are provided, it will reverse geocode the countryID. Additionally, if the "IncludeAllCountries" flag is set, and it is unable to reverse geocode the countryID, it will default the countryID to the US. If that fails and the search type is "InternationalRadius" the country will be ignored.

CategoryIDs

string

Can include comma-delimited list to limit to those categories

Radius

int32

Specify radius in miles. To perform a literal search unconstrained by radius, pass -1 as the radius. This will allow you to retrieve all locations in a given postal code, state, or city/state, or matching a given keyword

StartIndex

int32

required

Use this to specify the start number of the results for the page you are requesting.

PageSize

int32

required

Specify the number of results returned within a paging request.

Latitude

string

If you specify a lat/lon pair, a radius search will be performed regardless of the configured search rules.

Longitude

string

If you specify a lat/lon pair, a radius search will be performed regardless of the configured search rules.

Keyword

string

Keyword search will perform a string match against the location name.

UserIPAddress

string

If you specify a user IP address, then this will be checked against the list of blocked IP addresses for this client. If the address is on the block list, the search will not be performed, and a 403 (forbidden) response code will be returned. Passing this argument also causes the given IP address to be logged, if search logging is enabled for this client. (If the user IP is not passed in, then the IP of the machine calling the web service will be logged.)

ReturnGeocode

boolean

If this flag is set, the web service call will geocode any locations that need it

FillAttr

boolean

If the FillAttr parameter is set to true, the web service will fill in the Attributes list in each location result. If not, then the attributes list will not be filled in. (In some instances, returning attributes can slow down the search. Do not return attributes unless you need them.)

ReturnEvent

boolean

If set to true, the web service will fill in the events list in each location result.

ReturnCoupon

boolean

If set to true, the web service will fill in the coupons list in each location result.

ReturnServices

boolean

Defaults to false

When set to "True", this parameter results in two flags on the Location object being set for each location: IsStoreLocator and IsLeadManager. If not set, or set to false, these fields will not be populated and should be ignored

SearchSourceName

string

Used to indicate the source of this search, for reporting purposes. Default source names are “Web” and “Facebook”. To use another source, you must set it up via the Bullseye admin site.

SearchTypeOverride

int32

See notes below.

CountryScope

string

This optional parameter is used to access all locations regardless of what country they are in. It must be used in conjunction with the SearchTypeOverride parameter being set to Country Search. It also requires that the Other International subscription has been set up through the Bullseye admin site, as it uses the search and sort rules associated with this subscription. For now this parameter only has one acceptable value, "All", which will return all locations worldwide. The locations can be filtered by Category and Keyword if those parameters have been provided.

MaxResults

int32

Used to set a ceiling on the number of results returned if this has not been set for a specific country, or to override that setting if it exists for the country that is being searched.

MatchAllCategories

boolean

Defaults to false

By default performing a search with multiple categories will return locations that match "any" of the categories in the request. For search requests which require locations 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. Setting this parameter to "True" will return results that match "all" categories.

FindNearestForNoResults

boolean

Defaults to false

Setting this parameter to "True" will return the single nearest result regardless of the specified radius. Results are limited to the country of the original request. Results are sorted based on distance and dealer type, the sort order cannot be overwritten with the SearchOrderOverride parameter.

LanguageCode

string

Specify the ISO code of the language that results should be returned. Will return custom translations for both labels and categories if that subscription is enabled. Otherwise, will return global translations for labels only. See Language Codes/IDs here

LanguageID

int32

Specify the Bullseye LanguageID to request translated values as defined above. See Language Codes/IDs here

GetHoursForUpcomingWeek

boolean

Defaults to false

If set to True, the web service will return daily business hours

PromotionId

int32

The ID associated with a Promotion. This optional parameter is used to limit search results to locations assigned to a promtion.

PromotionName

string

The name associated with a Promotion. This optional parameter is used to limit search results to locations assigned to a promtion.

SearchOrderOverride

string

This overrides the configured sort order for a specific country in the account. This does not override the sort order of FindNearestForNoResults. Valid sort options: Dealer Type, Distance, Internet Locations First, Internet Locations Last, Random.

IncludeInternet

boolean

Defaults to false

Includes internet only locations with the normal results for the search. This will override the Internet Locations setting in the Search Rules for the country used in the search.

IncludeTerritoryData

boolean

If set to true, all territories associated with each location will be included in the return results

FilterTerritoryData

boolean

If set to true and IncludeTerrritoryData is set to true, the returned territories will be filtered to only return territories relative to the provided search location

DepartmentIDs

string

Can include comma-delimited list to limit to those locations associated with the departments in the list

CombineResultsWithDepartments

boolean

Defaults to false

Will combine locations not assigned to any departments with those specified by the DepartmentIDs parameter

AvailabilityLimiterIDs

string

Can include comma-delimited list to limit to those locations category associated with the availability in the list

ExcludeCategories

string

Defaults to false

If set to true, category data will not be included in the response. This can improve performance if there a lot of categories and categories are not needed.

Responses

200200

400400