Share via

GeocodingBatchRequestItem interface

  • Reference
Package:
@azure-rest/maps-search

Batch Query object

Properties

addressLine

The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.

If query is given, should not use this parameter.
adminDistrict

The country subdivision portion of an address, such as WA.

If query is given, should not use this parameter.
adminDistrict2

The county for the structured address, such as King.

If query is given, should not use this parameter.
adminDistrict3

The named area for the structured address.

If query is given, should not use this parameter.
bbox

A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. For more information, see Location and Area Types. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.

Example: [lon1, lat1, lon2, lat2]
coordinates

A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: [lon, lat]
countryRegion

Restrict the geocoding result to an ISO 3166-1 Alpha-2 region/country code that is specified e.g. FR. This will limit the search to the specified region.

If query is given, should not use this parameter.
locality

The locality portion of an address, such as Seattle.

If query is given, should not use this parameter.
optionalId

id of the request which would show in corresponding batchItem
postalCode

The postal code portion of an address.

If query is given, should not use this parameter.
query

A string that contains information about a location, such as an address or landmark name.
top

Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20.
view

A string that specifies an ISO 3166-1 Alpha-2 region/country code. This will alter Geopolitical disputed borders and labels to align with the specified user region.

Property Details

addressLine

The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.

If query is given, should not use this parameter.

addressLine?: string

Property Value

string

adminDistrict

The country subdivision portion of an address, such as WA.

If query is given, should not use this parameter.

adminDistrict?: string

Property Value

string

adminDistrict2

The county for the structured address, such as King.

If query is given, should not use this parameter.

adminDistrict2?: string

Property Value

string

adminDistrict3

The named area for the structured address.

If query is given, should not use this parameter.

adminDistrict3?: string

Property Value

string

bbox

A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by longitude and latitude values. For more information, see Location and Area Types. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.

Example: [lon1, lat1, lon2, lat2]

bbox?: number[]

Property Value

number[]

coordinates

A point on the earth specified as a longitude and latitude. When you specify this parameter, the user’s location is taken into account and the results returned may be more relevant to the user. Example: [lon, lat]

coordinates?: number[]

Property Value

number[]

countryRegion

Restrict the geocoding result to an ISO 3166-1 Alpha-2 region/country code that is specified e.g. FR. This will limit the search to the specified region.

If query is given, should not use this parameter.

countryRegion?: string

Property Value

string

locality

The locality portion of an address, such as Seattle.

If query is given, should not use this parameter.

locality?: string

Property Value

string

optionalId

id of the request which would show in corresponding batchItem

optionalId?: string

Property Value

string

postalCode

The postal code portion of an address.

If query is given, should not use this parameter.

postalCode?: string

Property Value

string

query

A string that contains information about a location, such as an address or landmark name.

query?: string

Property Value

string

top

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

top?: number

Property Value

number

view

A string that specifies an ISO 3166-1 Alpha-2 region/country code. This will alter Geopolitical disputed borders and labels to align with the specified user region.

view?: string

Property Value

string