SearchRequest Class

 

This documentation is no longer available on MSDN. It is available as a CHM or PDF download. For the newest Geocoding, Imagery, Routing and Traffic services, see Bing Maps REST Services. 

Contains the properties needed to make a Search service request. This class inherits from the RequestBase Class.

Syntax

public class SearchRequest : RequestBase
Public Class SearchRequest Inherits RequestBase

Constructor

Name

Description

SearchRequest 

Initializes a new instance of a SearchRequest object.

Public Properties

Name

Description

Credentials

A Credentials Class object that identifies the requestor. Required. (Inherited from the RequestBase Class.)

Culture

A string specifying the culture in which to return results. Optional. The default value is "en-US". (Inherited from the RequestBase Class.)

ExecutionOptions

An ExecutionOptions Class object specifying calculation and return options of the request. Optional. (Inherited from the RequestBase Class.)

Query 

A string containing the query to parse and match to a search result. Optional.

SearchOptions 

A SearchOptions Class object used to refine the search request. Optional.

StructuredQuery 

A StructuredSearchQuery Class object containing the query to match to a search result. Optional.

UserProfile

A UserProfile Class object containing user information helpful in service calculations. Optional. (Inherited from the RequestBase Class.)

Remarks

The Query, StructuredQuery, and SearchOptions properties are optional, but at least one of the following must be set: Query, StructuredQuery, or SearchOptions.Filters Property.

The Query and StructuredQuery properties cannot both be specified.

If the Query and StructuredQuery properties are not specified, then the SearchOptions.Filters property can only contain filters with a property ID of 1 (category filter).

See Also

SearchServiceClient.Search Method
SearchResponse Class
Search Filter Property Table