GeocodingBatchRequestItem interface

Pakket:

@azure-rest/maps-search

BatchQuery-object

Eigenschappen

addressLine	De officiële straatregel van een adres ten opzichte van het gebied, zoals opgegeven door de eigenschappen van de plaats, of postalCode. Dit element wordt doorgaans gebruikt om een adres of een officieel adres op te geven. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
adminDistrict	Het onderverdelingsgedeelte van het land van een adres, zoals WA. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
adminDistrict2	De provincie voor het gestructureerde adres, zoals King. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
adminDistrict3	Het benoemde gebied voor het gestructureerde adres. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
bbox	Een rechthoekig gebied op de aarde gedefinieerd als een begrenzingsvakobject. De zijden van de rechthoeken worden gedefinieerd door lengte- en breedtegraadwaarden. Zie Locatie- en gebiedstypen voor meer informatie. Wanneer u deze parameter opgeeft, wordt rekening gehouden met het geografische gebied bij het berekenen van de resultaten van een locatiequery. Voorbeeld: [lon1, lat1, lon2, lat2]
coordinates	Een punt op de aarde dat is opgegeven als een lengtegraad en breedtegraad. Wanneer u deze parameter opgeeft, wordt rekening gehouden met de locatie van de gebruiker en zijn de geretourneerde resultaten mogelijk relevanter voor de gebruiker. Voorbeeld: [lon, lat]
countryRegion	Beperk het resultaat van de geocodering tot een ISO 3166-1 Alpha-2 regio-/landcode die is opgegeven, bijvoorbeeld FR. Hiermee wordt de zoekopdracht beperkt tot de opgegeven regio. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
locality	Het plaatsgedeelte van een adres, zoals Seattle. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
optionalId	id van de aanvraag die wordt weergegeven in de bijbehorende batchItem
postalCode	Het postcodegedeelte van een adres. Als de query wordt gegeven, mag deze parameter niet worden gebruikt.
query	Een tekenreeks die informatie bevat over een locatie, zoals een adres of oriëntatiepuntnaam.
top	Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 5, minimaal: 1 en maximaal 20.
view	Een tekenreeks die een ISO 3166-1 Alpha-2-regio-/landcode aangeeft. Hierdoor worden geopolitieke omstreden grenzen en labels aangepast aan de opgegeven gebruikersregio.

Eigenschapdetails

addressLine

De officiële straatregel van een adres ten opzichte van het gebied, zoals opgegeven door de eigenschappen van de plaats, of postalCode. Dit element wordt doorgaans gebruikt om een adres of een officieel adres op te geven.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

addressLine?: string

Waarde van eigenschap

string

adminDistrict

Het onderverdelingsgedeelte van het land van een adres, zoals WA.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

adminDistrict?: string

Waarde van eigenschap

string

adminDistrict2

De provincie voor het gestructureerde adres, zoals King.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

adminDistrict2?: string

Waarde van eigenschap

string

adminDistrict3

Het benoemde gebied voor het gestructureerde adres.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

adminDistrict3?: string

Waarde van eigenschap

string

bbox

Een rechthoekig gebied op de aarde gedefinieerd als een begrenzingsvakobject. De zijden van de rechthoeken worden gedefinieerd door lengte- en breedtegraadwaarden. Zie Locatie- en gebiedstypen voor meer informatie. Wanneer u deze parameter opgeeft, wordt rekening gehouden met het geografische gebied bij het berekenen van de resultaten van een locatiequery.

Voorbeeld: [lon1, lat1, lon2, lat2]

bbox?: number[]

Waarde van eigenschap

number[]

coordinates

Een punt op de aarde dat is opgegeven als een lengtegraad en breedtegraad. Wanneer u deze parameter opgeeft, wordt rekening gehouden met de locatie van de gebruiker en zijn de geretourneerde resultaten mogelijk relevanter voor de gebruiker. Voorbeeld: [lon, lat]

coordinates?: number[]

Waarde van eigenschap

number[]

countryRegion

Beperk het resultaat van de geocodering tot een ISO 3166-1 Alpha-2 regio-/landcode die is opgegeven, bijvoorbeeld FR. Hiermee wordt de zoekopdracht beperkt tot de opgegeven regio.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

countryRegion?: string

Waarde van eigenschap

string

locality

Het plaatsgedeelte van een adres, zoals Seattle.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

locality?: string

Waarde van eigenschap

string

optionalId

id van de aanvraag die wordt weergegeven in de bijbehorende batchItem

optionalId?: string

Waarde van eigenschap

string

postalCode

Het postcodegedeelte van een adres.

Als de query wordt gegeven, mag deze parameter niet worden gebruikt.

postalCode?: string

Waarde van eigenschap

string

query

Een tekenreeks die informatie bevat over een locatie, zoals een adres of oriëntatiepuntnaam.

query?: string

Waarde van eigenschap

string

top

Maximum aantal antwoorden dat wordt geretourneerd. Standaard: 5, minimaal: 1 en maximaal 20.

top?: number

Waarde van eigenschap

number

view

Een tekenreeks die een ISO 3166-1 Alpha-2-regio-/landcode aangeeft. Hierdoor worden geopolitieke omstreden grenzen en labels aangepast aan de opgegeven gebruikersregio.

view?: string

Waarde van eigenschap

string