SearchGetSearchAddressStructuredOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
country |
The county for the structured address |
country |
The country subdividion portion of an address |
country |
The named area for the structured address |
cross |
The cross street name for the structured address |
extended |
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. |
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. |
limit | Maximum number of responses that will be returned |
municipality | The municipality portion of an address |
municipality |
The municipality subdivision (sub/super city) for the structured address |
ofs | Starting offset of the returned results within the full result set |
postal |
The postal code portion of an address |
street |
The street name portion of an address |
street |
The street number portion of an address |
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
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
countrySecondarySubdivision
The county for the structured address
countrySecondarySubdivision?: string
Property Value
string
countrySubdivision
The country subdividion portion of an address
countrySubdivision?: string
Property Value
string
countryTertiarySubdivision
The named area for the structured address
countryTertiarySubdivision?: string
Property Value
string
crossStreet
The cross street name for the structured address
crossStreet?: 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
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
limit
Maximum number of responses that will be returned
limit?: number
Property Value
number
municipality
The municipality portion of an address
municipality?: string
Property Value
string
municipalitySubdivision
The municipality subdivision (sub/super city) for the structured address
municipalitySubdivision?: string
Property Value
string
ofs
Starting offset of the returned results within the full result set
ofs?: number
Property Value
number
postalCode
The postal code portion of an address
postalCode?: string
Property Value
string
streetName
The street name portion of an address
streetName?: string
Property Value
string
streetNumber
The street number portion of an address
streetNumber?: string
Property Value
string
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