Edit

SearchGetSearchFuzzyOptionalParams interface

  • Reference
Package:
azure-maps-rest

Optional Parameters.

Extends

RequestOptionsBase

Properties

brandSet

A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Comma",Bar
btmRight

Bottom right position of the bounding box. E.g. 37.553,-122.453
connectorSet

A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are:

  • StandardHouseholdCountrySpecific - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards.
  • IEC62196Type1 - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.
  • IEC62196Type1CCS - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type2CableAttached - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.
  • IEC62196Type2Outlet - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.
  • IEC62196Type2CCS - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type3 - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.
  • Chademo - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.
  • IEC60309AC1PhaseBlue - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration.
  • IEC60309DCWhite - Industrial White connector is a DC connector defined in the IEC 60309 standard.
  • Tesla - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.

Usage examples:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet

Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries
extendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.
idxSet

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)
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.
lat

Latitude where results should be biased. E.g. 37.337
limit

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

Longitude where results should be biased. E.g. -121.89
maxFuzzyLevel

Maximum fuzzyness level to be used. Default: 2, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.
minFuzzyLevel

Minimum fuzzyness level to be used. Default: 1, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.
ofs

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

Opening hours for a POI (Points of Interest). The availability of opening hours will vary based on the data available. Possible values include: 'nextSevenDays'
radius

The radius in meters to for the results to be constrained to the defined area
topLeft

Top left position of the bounding box. E.g. 37.553,-122.453
typeahead

Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode
view

The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. 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 Properties

abortSignal

The signal which can be used to abort requests.
customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
onDownloadProgress

Callback which fires upon download progress.
onUploadProgress

Callback which fires upon upload progress.
timeout

The number of milliseconds a request can take before automatically being terminated.

Property Details

brandSet

A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Comma",Bar

brandSet?: string[]

Property Value

string[]

btmRight

Bottom right position of the bounding box. E.g. 37.553,-122.453

btmRight?: string

Property Value

string

connectorSet

A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are:

  • StandardHouseholdCountrySpecific - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards.
  • IEC62196Type1 - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.
  • IEC62196Type1CCS - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type2CableAttached - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.
  • IEC62196Type2Outlet - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.
  • IEC62196Type2CCS - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.
  • IEC62196Type3 - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.
  • Chademo - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.
  • IEC60309AC1PhaseBlue - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration.
  • IEC60309DCWhite - Industrial White connector is a DC connector defined in the IEC 60309 standard.
  • Tesla - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.

Usage examples:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

Property Value

ConnectorSet[]

countrySet

Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries

countrySet?: string[]

Property Value

string[]

extendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

extendedPostalCodesFor?: string

Property Value

string

idxSet

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)

idxSet?: SearchIndexSet[]

Property Value

SearchIndexSet[]

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.

language?: string

Property Value

string

lat

Latitude where results should be biased. E.g. 37.337

lat?: number

Property Value

number

limit

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

limit?: number

Property Value

number

lon

Longitude where results should be biased. E.g. -121.89

lon?: number

Property Value

number

maxFuzzyLevel

Maximum fuzzyness level to be used. Default: 2, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.

maxFuzzyLevel?: number

Property Value

number

minFuzzyLevel

Minimum fuzzyness level to be used. Default: 1, minimum: 1 and maximum: 4

  • Level 1 has no spell checking.

  • Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."

  • Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching.

  • Level 4 doesn’t add any more spell checking functions.

The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.

minFuzzyLevel?: number

Property Value

number

ofs

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

ofs?: number

Property Value

number

openingHours

Opening hours for a POI (Points of Interest). The availability of opening hours will vary based on the data available. Possible values include: 'nextSevenDays'

openingHours?: OpeningHours

Property Value

OpeningHours

radius

The radius in meters to for the results to be constrained to the defined area

radius?: number

Property Value

number

topLeft

Top left position of the bounding box. E.g. 37.553,-122.453

topLeft?: string

Property Value

string

typeahead

Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode

typeahead?: boolean

Property Value

boolean

view

The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. 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.

view?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

Inherited From RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From RequestOptionsBase.timeout