Share via

SearchStructuredAddressOptions Class

  • Reference

Definition

Namespace:
Azure.Maps.Search.Models
Assembly:
Azure.Maps.Search.dll
Package:
Azure.Maps.Search v1.0.0-beta.5
Source:
SearchStructuredAddressOptions.cs

Options.

public class SearchStructuredAddressOptions : Azure.Maps.Search.SearchBaseOptions
type SearchStructuredAddressOptions = class
    inherit SearchBaseOptions
Public Class SearchStructuredAddressOptions
Inherits SearchBaseOptions
Inheritance
Object
SearchBaseOptions
SearchStructuredAddressOptions

Constructors

SearchStructuredAddressOptions()

Properties

EntityType

Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. The following parameters are ignored when entityType is set:

  • heading
  • number
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
ExtendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Please refer to SearchIndex for all the available search indexes
Language

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.

(Inherited from SearchBaseOptions)
LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

(Inherited from SearchBaseOptions)
Skip

Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.

(Inherited from SearchBaseOptions)
Top

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.

(Inherited from SearchBaseOptions)

Applies to