@azure-rest/maps-search package

  • Referentie

Interfaces

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

Het adres van het resultaat
BoundaryOutput

GeoJSON GeocodingFeature -object dat de grenzen van een geografisch gebied beschrijft. Geometrie van de functie wordt beschreven met GeoJSON GeometryCollection.

Houd er rekening mee dat de service doorgaans een GeometryCollection retourneert met het subtype Polygon of MultiPolygon.
BoundaryPropertiesOutput

Eigenschappen van een Boundary-object.
ErrorAdditionalInfoOutput

Aanvullende informatie over de resourcebeheerfout.
ErrorDetailOutput

De foutdetails.
ErrorResponseOutput

Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

Een geldig GeoJSON FeatureCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometryOutputParent

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonLineStringDataOutput
GeoJsonLineStringOutput

Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiLineStringDataOutput
GeoJsonMultiLineStringOutput

Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPointDataOutput

Gegevens die zijn opgenomen in een GeoJson MultiPoint.
GeoJsonMultiPointOutput

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonMultiPolygonDataOutput
GeoJsonMultiPolygonOutput

Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonObjectOutputParent

Een geldig GeoJSON object. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPointDataOutput

Gegevens die zijn opgenomen in een GeoJson Point.
GeoJsonPointOutput

Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonPolygonDataOutput
GeoJsonPolygonOutput

Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946 voor meer informatie.
GeocodePointsItemOutput
GeocodingBatchRequestBody

De lijst met adresgeocoderingsquery's/aanvragen die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.
GeocodingBatchRequestItem

BatchQuery-object
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Dit object wordt geretourneerd na een geslaagde Geocoding Batch-serviceoproep.
GeocodingBatchResponseSummaryOutput

Samenvatting voor de batchaanvraag
GeocodingResponseOutput

Dit object wordt geretourneerd na een geslaagde geocoderingsoproep
GeometryCopyrightOutput

Copyrightinformatie van een geometrie van een Boundary-object.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Het adres van het resultaat.
ReverseGeocodingBatchRequestBody

De lijst met query's/aanvragen voor omgekeerde geocodering die moeten worden verwerkt. De lijst kan maximaal 100 query's bevatten en moet ten minste 1 query bevatten.
ReverseGeocodingBatchRequestItem

BatchQuery-object
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

Geocodering

Van toepassing op: zie prijscategorieën.

In veel gevallen kan de volledige zoekservice te veel zijn, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocodering. U kunt ook zoeken om uitsluitend adressen op te zoeken. De geocodering wordt uitgevoerd door het geocoderingseindpunt te raken met alleen het adres of het gedeeltelijke adres in kwestie. De zoekindex voor geocodering wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen nuttige plaatsen (POI's) geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is voor typfouten en onvolledige adressen. Het verwerkt ook alles van exacte adressen of straat of kruispunten, evenals geografische gebieden op een hoger niveau, zoals stadscentra, provincies, staten, enz.
SearchGetGeocodingBatch200Response

Geocodering batch-API

Van toepassing op: zie prijscategorieën.

De Batch-API voor geocodering verzendt batches query's naar geocoderings-API met behulp van slechts één API-aanroep. Met de API kan de aanroeper maximaal 100 query's batches uitvoeren.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de geocoderingsquery's gebruikt u een POST aanvraag waarbij de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op .application/json Hier volgt een voorbeeld van een aanvraagbody met 2 geocoderingsquery's:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Een batchItem-object voor geocodering kan een van de ondersteunde geocoderings-URI-parameters accepteren.

De batch moet ten minste één query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequests dat wil zeggen query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's die in de batchaanvraag zijn verzonden. Elk item heeft een van de volgende typen:

  • GeocodingResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in dit geval een code en een message .
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Geocodering batch-API

Van toepassing op: zie prijscategorieën.

De Batch-API voor geocodering verzendt batches query's naar geocoderings-API met behulp van slechts één API-aanroep. Met de API kan de aanroeper maximaal 100 query's batches uitvoeren.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de geocoderingsquery's gebruikt u een POST aanvraag waarbij de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op .application/json Hier volgt een voorbeeld van een aanvraagbody met 2 geocoderingsquery's:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Een batchItem-object voor geocodering kan een van de ondersteunde geocoderings-URI-parameters accepteren.

De batch moet ten minste één query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequests dat wil zeggen query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's die in de batchaanvraag zijn verzonden. Elk item heeft een van de volgende typen:

  • GeocodingResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in dit geval een code en een message .
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Geocodering

Van toepassing op: zie prijscategorieën.

In veel gevallen kan de volledige zoekservice te veel zijn, bijvoorbeeld als u alleen geïnteresseerd bent in traditionele geocodering. U kunt ook zoeken om uitsluitend adressen op te zoeken. De geocodering wordt uitgevoerd door het geocoderingseindpunt te raken met alleen het adres of het gedeeltelijke adres in kwestie. De zoekindex voor geocodering wordt opgevraagd voor alles boven de gegevens op straatniveau. Er worden geen nuttige plaatsen (POI's) geretourneerd. Houd er rekening mee dat de geocoder zeer tolerant is voor typfouten en onvolledige adressen. Het verwerkt ook alles van exacte adressen of straat of kruispunten, evenals geografische gebieden op een hoger niveau, zoals stadscentra, provincies, staten, enz.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

Veelhoek ophalen

Van toepassing op: zie prijscategorieën.

Levert veelhoekgegevens van een geografisch gebiedsoverzicht, zoals een stad of een land.
SearchGetPolygonDefaultResponse

Veelhoek ophalen

Van toepassing op: zie prijscategorieën.

Levert veelhoekgegevens van een geografisch gebiedsoverzicht, zoals een stad of een land.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

Omgekeerde geocodering

Van toepassing op: zie prijscategorieën.

Vertaal een coördinaat (bijvoorbeeld: 37.786505, -122.3862) naar een voor mensen begrijpelijk adres. Meestal is dit nodig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of asset ontvangt en wilt weten op welk adres de coördinaat zich bevindt. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.
SearchGetReverseGeocodingBatch200Response

Batch-API voor omgekeerde geocodering

Van toepassing op: zie prijscategorieën.

De Batch-API voor reverse geocodering verzendt batches query's naar reverse geocodering-API met slechts één API-aanroep. Met de API kan de aanroeper maximaal 100 query's batches uitvoeren.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de omgekeerde geocoderingsquery's gebruikt u een POST aanvraag waarbij de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 query's voor omgekeerde geocodering :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Een batchItem-object met omgekeerde geocodering kan een van de ondersteunde URI-parameters voor omgekeerde geocodering accepteren.

De batch moet ten minste één query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequests dat wil zeggen query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's die in de batchaanvraag zijn verzonden. Elk item heeft een van de volgende typen:

  • GeocodingResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in dit geval een code en een message .
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

Batch-API voor omgekeerde geocodering

Van toepassing op: zie prijscategorieën.

De Batch-API voor reverse geocodering verzendt batches query's naar reverse geocodering-API met slechts één API-aanroep. Met de API kan de aanroeper maximaal 100 query's batches uitvoeren.

Synchrone batchaanvraag verzenden

De synchrone API wordt aanbevolen voor lichtgewicht batchaanvragen. Wanneer de service een aanvraag ontvangt, reageert deze zodra de batch-items zijn berekend en is het niet mogelijk om de resultaten later op te halen. De synchrone API retourneert een time-outfout (een 408-antwoord) als de aanvraag langer duurt dan 60 seconden. Het aantal batch-items is beperkt tot 100 voor deze API.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

POST-hoofdtekst voor Batch-aanvraag

Voor het verzenden van de omgekeerde geocoderingsquery's gebruikt u een POST aanvraag waarbij de aanvraagbody de batchItems matrix in json indeling bevat en de Content-Type header wordt ingesteld op application/json. Hier volgt een voorbeeld van een aanvraagbody met 2 query's voor omgekeerde geocodering :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

Een batchItem-object met omgekeerde geocodering kan een van de ondersteunde URI-parameters voor omgekeerde geocodering accepteren.

De batch moet ten minste één query bevatten.

Batch-antwoordmodel

Het batchantwoord bevat een summary onderdeel dat aangeeft dat deel uitmaakt totalRequests van de oorspronkelijke batchaanvraag en successfulRequests dat wil zeggen query's die zijn uitgevoerd. Het batchantwoord bevat ook een batchItems matrix die een antwoord bevat voor elke query in de batchaanvraag. De batchItems bevat de resultaten in exact dezelfde volgorde als de oorspronkelijke query's die in de batchaanvraag zijn verzonden. Elk item heeft een van de volgende typen:

  • GeocodingResponse - Als de query is voltooid.

  • Error - Als de query is mislukt. Het antwoord bevat in dit geval een code en een message .
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

Omgekeerde geocodering

Van toepassing op: zie prijscategorieën.

Vertaal een coördinaat (bijvoorbeeld: 37.786505, -122.3862) naar een voor mensen begrijpelijk adres. Meestal is dit nodig bij het bijhouden van toepassingen waarbij u een GPS-feed van het apparaat of asset ontvangt en wilt weten op welk adres de coördinaat zich bevindt. Dit eindpunt retourneert adresgegevens voor een bepaalde coördinaat.
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

Type-aliassen

GeoJsonFeatureOutput

Een geldig GeoJSON Feature objecttype. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonGeometryOutput

Een geldig GeoJSON geometrieobject. Het type moet een van de zeven geldige GeoJSON-geometrietypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon en GeometryCollection. Raadpleeg RFC 7946 voor meer informatie.
GeoJsonObjectOutput

Een geldig GeoJSON object. Raadpleeg RFC 7946 voor meer informatie.
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

Functies

default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity TokenCredential.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity AzureSASCredential.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

Functiedetails

default(AzureKeyCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient

Parameters

credential
AzureKeyCredential

Een AzureKeyCredential-exemplaar dat wordt gebruikt om aanvragen voor de service te verifiëren

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

default(TokenCredential, string, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity TokenCredential.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient

Parameters

credential
TokenCredential

Een TokenCredential-exemplaar dat wordt gebruikt om aanvragen voor de service te verifiëren

mapsAccountClientId

string

De Azure Maps client-id van een specifieke toewijzingsresource

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Hiermee maakt u een exemplaar van MapsSearch op basis van een Azure Identity AzureSASCredential.

Voorbeeld

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient

Parameters

credential
AzureSASCredential

Een AzureSASCredential-exemplaar dat wordt gebruikt om aanvragen voor de service te verifiëren

options
ClientOptions

Opties die worden gebruikt voor het configureren van de zoekclient

Retouren

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

Parameters

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

Retouren

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

Parameters

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

Retouren

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

Parameters

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

Retouren

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

Parameters

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

Retouren

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

Parameters

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

Retouren

response