Search - Post Search Along Route

Service:

Maps

API Version:

1.0

Gebruik om een fuzzy zoekopdracht uit te voeren naar POI's langs een opgegeven route.

De Post Search Along Route API is een HTTP-aanvraag POST waarmee u een fuzzy zoekopdracht naar POIs langs een opgegeven route kunt uitvoeren. Deze zoekopdracht wordt beperkt door de maxDetourTime beperkende meting op te geven.

Voor het verzenden van de routepunten gebruikt u een POST aanvraag waarbij de hoofdtekst van de aanvraag het route object bevat dat wordt weergegeven als een GeoJSON LineString type en de Content-Type header wordt ingesteld op application/json. Elk routepunt in route wordt weergegeven als een GeoJSON Position type, dat wil zeggen een matrix waarbij de lengtegraadwaarde wordt gevolgd door de breedtegraadwaarde en de hoogtewaarde wordt genegeerd. De route moet ten minste 2 routepunten bevatten.

Het is mogelijk dat de oorspronkelijke route wordt gewijzigd en dat sommige punten worden overgeslagen. Als de route die het gevonden punt passeert, sneller is dan de oorspronkelijke, is de detourTime waarde in het antwoord negatief.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}

With optional parameters:

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json of xml zijn.
api-version	query	True	string	Versienummer van Azure Maps API.
maxDetourTime	query	True	integer	Maximale omleidingstijd van de nuttige plaats in seconden. De maximale waarde is 3600 seconden
query	query	True	string	De POI-naam die moet worden gezocht (bijvoorbeeld 'vrijheidsbeeld', 'starbucks', 'pizza'). De URL moet correct zijn gecodeerd.
brandSet	query		string[]	Een door komma's gescheiden lijst met merknamen die kunnen worden gebruikt om het resultaat te beperken tot specifieke merken. De volgorde van het artikel maakt niet uit. Wanneer meerdere merken worden opgegeven, worden alleen resultaten geretourneerd die tot (ten minste) één van de opgegeven lijst behoren. Merken met een ',' in hun naam moeten tussen aanhalingstekens worden geplaatst. Gebruiksvoorbeelden: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C-komma",Balk
categorySet	query		integer[]	Een door komma's gescheiden lijst met categorie-id's die kunnen worden gebruikt om het resultaat te beperken tot specifieke Nuttige plaatsen-categorieën. Id-volgorde maakt niet uit. Het maximum aantal categorySet ondersteunde waarden per aanvraag is 10. Wanneer er meerdere categorie-id's worden opgegeven, worden alleen POI's geretourneerd die deel uitmaken van (ten minste) een van de categorieën uit de opgegeven lijst. De lijst met ondersteunde categorieën kan worden gedetecteerd met behulp van DE API voor POI-categorieën . Gebruiksvoorbeelden: categorySet=7315 (Search Nuttige plaatsen uit categorie Restaurant) categorySet=7315025,7315017 (Search Nuttige plaatsen van de categorie Italiaans of Frans restaurant)
connectorSet	query		ElectricVehicleConnector[]	Een door komma's gescheiden lijst met verbindingslijntypen die kunnen worden gebruikt om het resultaat te beperken tot elektrisch voertuigstation dat specifieke verbindingslijntypen ondersteunt. De volgorde van het artikel maakt niet uit. Wanneer er meerdere connectortypen worden opgegeven, worden alleen resultaten geretourneerd die deel uitmaken van (ten minste) één van de opgegeven lijst. Beschikbare connectortypen zijn: StandardHouseholdCountrySpecific - Dit zijn de standaard huishoudelijke connectors voor een bepaalde regio. Ze zijn allemaal AC eenfase en de standaard spanning en standaard Amperage. Zie ook: Plug & socket types - World Standards. IEC62196Type1 - Type 1-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Yazaki genoemd naar de oorspronkelijke fabrikant of SAE J1772 naar de standaard die het eerst publiceerde. Meestal gebruikt in combinatie met 120V single phase of tot 240V single phase infrastructuur. IEC62196Type1CCS - Type 1 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 1-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om snel opladen met gelijkstroom mogelijk te maken. IEC62196Type2CableAttached - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als een kabel en stekker bevestigd aan het oplaadpunt. IEC62196Type2Outlet - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als stopcontact in het oplaadpunt. IEC62196Type2CCS - Type 2 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 2-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om dc snel opladen mogelijk te maken. IEC62196Type3 - Type 3-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Scame genoemd naar de oorspronkelijke fabrikant. Meestal gebruikt in combinatie met tot 240V éénfase of tot 420V driefase infrastructuur. Chademo - CHAdeMO-connector genoemd naar een vereniging gevormd door de Tokyo Electric Power Company en industriële partners. Hierdoor wordt ook wel de TEPCO-connector genoemd. Het ondersteunt snel opladen via DC. IEC60309AC1PhaseBlue - Industriële blauwe connector is een connector die is gedefinieerd in de IEC 60309-standaard. Het wordt soms aangeduid als door een combinatie van de standaard, de kleur en het feit dat een eenfaseconnector is. De connector heeft meestal de configuratie 'P+N+E, 6h'. IEC60309DCWhite - Industriële witte connector is een DC-connector die is gedefinieerd in de IEC 60309-standaard. Tesla - De Tesla-connector is de regionaal specifieke Tesla Supercharger-connector. D.w.z. het verwijst naar de eigen connector van Tesla, soms aangeduid als Tesla Port meestal beperkt tot Noord-Amerika of het gewijzigde Type 2 (DC boven Type 2) in Europa. Gebruiksvoorbeelden: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
limit	query		integer	Maximum aantal antwoorden dat wordt geretourneerd. De standaardwaarde is 10. De maximumwaarde is 20
openingHours	query		OperatingHoursRange	Openingstijden voor een POI (Nuttige plaatsen). De beschikbaarheid van bedrijfsuren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, wordt er geen informatie over de openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays
view	query		LocalizedMapView	Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de weergaveparameter correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN. Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

Name	Type	Description
route	GeoJsonLineString	Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

Antwoorden

Name	Type	Description
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notitie

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API .
• De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties.
• Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
• Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere use cases.
• Zie Microsoft identity platform overzicht voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een shared access signature-token dat wordt gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle over het verloop, de snelheid en de gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Search for burger joints along a route

Sample Request

HTTP

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Sample Response

Status code:

200

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

Definities

Name	Description
Address	Het adres van het resultaat
AddressRanges	Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.
BoundingBox	De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.
BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
Brand	Het merk dat is gekoppeld aan de POI
Classification	De classificatie voor de POI die wordt geretourneerd
ClassificationName	Naam voor de classificatie
DataSources	Optionele sectie. Referentie-id's voor gebruik met de API Search veelhoek ophalen.
ElectricVehicleConnector	Een door komma's gescheiden lijst met verbindingslijntypen die kunnen worden gebruikt om het resultaat te beperken tot elektrisch voertuigstation dat specifieke verbindingslijntypen ondersteunt. De volgorde van het artikel maakt niet uit. Wanneer er meerdere connectortypen worden opgegeven, worden alleen resultaten geretourneerd die deel uitmaken van (ten minste) één van de opgegeven lijst. Beschikbare connectortypen zijn: StandardHouseholdCountrySpecific - Dit zijn de standaard huishoudelijke connectors voor een bepaalde regio. Ze zijn allemaal AC eenfase en de standaard spanning en standaard Amperage. Zie ook: Plug & socket types - World Standards. IEC62196Type1 - Type 1-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Yazaki genoemd naar de oorspronkelijke fabrikant of SAE J1772 naar de standaard die het eerst publiceerde. Meestal gebruikt in combinatie met 120V single phase of tot 240V single phase infrastructuur. IEC62196Type1CCS - Type 1 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 1-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om snel opladen met gelijkstroom mogelijk te maken. IEC62196Type2CableAttached - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als een kabel en stekker bevestigd aan het oplaadpunt. IEC62196Type2Outlet - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als stopcontact in het oplaadpunt. IEC62196Type2CCS - Type 2 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 2-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om dc snel opladen mogelijk te maken. IEC62196Type3 - Type 3-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Scame genoemd naar de oorspronkelijke fabrikant. Meestal gebruikt in combinatie met tot 240V éénfase of tot 420V driefase infrastructuur. Chademo - CHAdeMO-connector genoemd naar een vereniging gevormd door de Tokyo Electric Power Company en industriële partners. Hierdoor wordt ook wel de TEPCO-connector genoemd. Het ondersteunt snel opladen via DC. IEC60309AC1PhaseBlue - Industriële blauwe connector is een connector die is gedefinieerd in de IEC 60309-standaard. Het wordt soms aangeduid als door een combinatie van de standaard, de kleur en het feit dat een eenfaseconnector is. De connector heeft meestal de configuratie 'P+N+E, 6h'. IEC60309DCWhite - Industriële witte connector is een DC-connector die is gedefinieerd in de IEC 60309-standaard. Tesla - De Tesla-connector is de regionaal specifieke Tesla Supercharger-connector. D.w.z. het verwijst naar de eigen connector van Tesla, soms aangeduid als Tesla Port meestal beperkt tot Noord-Amerika of het gewijzigde Type 2 (DC boven Type 2) in Europa. Gebruiksvoorbeelden: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity	Bron van het entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
EntryPoint	Het toegangspunt voor de POI die wordt geretourneerd.
EntryPointType	Het type toegangspunt. De waarde kan main of minor zijn.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
GeographicEntityType	Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
GeoJsonLineString	Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.
Geometry	Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.
LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
LocalizedMapView	Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de weergaveparameter correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN. Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.
MatchType	Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.
OperatingHours	Openingstijden voor een POI (Points of Interest).
OperatingHoursRange	Openingstijden voor een POI (Nuttige plaatsen). De beschikbaarheid van bedrijfsuren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, wordt er geen informatie over de openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays
OperatingHoursTime	Vertegenwoordigt een datum en tijd
OperatingHoursTimeRange	Open tijdsbereik voor een dag
PointOfInterest	Details van de geretourneerde POI, inclusief informatie zoals de naam, het telefoonnummer, het URL-adres en de classificaties.
PointOfInterestCategorySet	POI-categorie
QueryType	Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.
ResponseFormat	Gewenste indeling van het antwoord. De waarde kan json of xml zijn.
SearchAddressResult	Dit object wordt geretourneerd na een geslaagde Search aanroepen.
SearchAddressResultItem	Resultaatobject voor een Search API-antwoord.
SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Straat kruisen
SearchAlongRouteRequest	Dit type vertegenwoordigt de aanvraagbody voor de Search Langs route-service.
SearchSummary	Samenvattingsobject voor een Search API-antwoord.

Address

Het adres van het resultaat

Name	Type	Description
boundingBox	BoundingBoxCompassNotation	Het begrenzingsvak van de locatie.
buildingNumber	string	Het nummer van het gebouw op straat. AFGESCHAFT, gebruikt u in plaats daarvan straatnummer.
country	string	naam van land/regio
countryCode	string	Land (opmerking: dit is een code van twee letters, niet een land/regionaam.)
countryCodeISO3	string	ISO alfa-3-landcode
countrySecondarySubdivision	string	Graafschap
countrySubdivision	string	Staat of provincie
countrySubdivisionCode	string	countrySubdivisionCode voorafgegaan door countryCode ( countryCode-countrySubdivisionCode ) en het afbreekstreepje vormt de ISO 3166-2-code. Voorbeelden: TX voor Texas, SCT voor Schotland en ON voor Ontario.
countrySubdivisionName	string	De volledige naam van een administratieve hiërarchie op het eerste niveau van een land/regio. Dit veld wordt alleen weergegeven als countrySubdivision in een verkorte vorm wordt weergegeven. Alleen ondersteund voor de VS, Canada en het Verenigd Koninkrijk.
countryTertiarySubdivision	string	Benoemd gebied
crossStreet	string	De naam van de straat die wordt gekruist.
extendedPostalCode	string	Uitgebreide postcode (beschikbaarheid is afhankelijk van de regio).
freeformAddress	string	Een adresregel die is opgemaakt volgens de opmaakregels van het land/de regio van herkomst van een resultaat, of, in het geval van een land/regio, de volledige land-/regionaam.
localName	string	Een adresonderdeel dat de naam vertegenwoordigt van een geografisch gebied of een locatie die meerdere adresseerbare objecten groepeert voor adresseringsdoeleinden, zonder dat het een beheereenheid is. Dit veld wordt gebruikt om de freeformAddress eigenschap te bouwen. localName vertegenwoordigt de post gemeente. Afhankelijk van de locatie is localName de algemeen bekende naam van een stad of stad. Gebruik localName voor de algemeen bekende naam van een stad of stad in plaats van municipality.
municipality	string	Plaats/plaats Opmerking: municipality vertegenwoordigt de woongemeente. Afhankelijk van de locatie kan de municipality waarde afwijken van de algemeen bekende naam van een stad of stad. Voor de algemeen bekende naam van de stad of stad wordt voorgesteld dat de localName waarde wordt gebruikt in plaats van de municipality waarde.
municipalitySubdivision	string	Sub-/superstad
neighbourhood	string	Een buurt is een geografisch gelokaliseerd gebied binnen een stad of stad met onderscheidende kenmerken en sociale interacties tussen inwoners.
postalCode	string	Postcode/postcode
routeNumbers	string[]	De codes die worden gebruikt om de straat ondubbelzinnig te identificeren
street	string	De straatnaam. AFGESCHAFT, gebruikt u in plaats daarvan streetName.
streetName	string	De straatnaam.
streetNameAndNumber	string	De straatnaam en het nummer.
streetNumber	string	Het nummer van het gebouw op straat.

AddressRanges

Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.

Name	Type	Description
from	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
rangeLeft	string	Adresbereik aan de linkerkant van de straat.
rangeRight	string	Adresbereik aan de rechterkant van de straat.
to	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBox

De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.

Name	Type	Description
btmRightPoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

BoundingBoxCompassNotation

Het begrenzingsvak van de locatie.

Name	Type	Description
entity	Entity	Bron van het entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.
northEast	string	Noordoostelijke breedtegraad, lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats
southWest	string	Zuid-west breedtegraad,lengtegraadcoördinaat van het begrenzingsvak als door komma's gescheiden floats

Brand

Het merk dat is gekoppeld aan de POI

Name	Type	Description
name	string	Naam van het merk

Classification

De classificatie voor de POI die wordt geretourneerd

Name	Type	Description
code	string	Code-eigenschap
names	ClassificationName[]	Namenmatrix

ClassificationName

Naam voor de classificatie

Name	Type	Description
name	string	Naameigenschap
nameLocale	string	Landinstellingseigenschap naam

DataSources

Optionele sectie. Referentie-id's voor gebruik met de API Search veelhoek ophalen.

Name	Type	Description
geometry	Geometry	Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.

ElectricVehicleConnector

Een door komma's gescheiden lijst met verbindingslijntypen die kunnen worden gebruikt om het resultaat te beperken tot elektrisch voertuigstation dat specifieke verbindingslijntypen ondersteunt. De volgorde van het artikel maakt niet uit. Wanneer er meerdere connectortypen worden opgegeven, worden alleen resultaten geretourneerd die deel uitmaken van (ten minste) één van de opgegeven lijst.

Beschikbare connectortypen zijn:

• StandardHouseholdCountrySpecific - Dit zijn de standaard huishoudelijke connectors voor een bepaalde regio. Ze zijn allemaal AC eenfase en de standaard spanning en standaard Amperage. Zie ook: Plug & socket types - World Standards.
• IEC62196Type1 - Type 1-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Yazaki genoemd naar de oorspronkelijke fabrikant of SAE J1772 naar de standaard die het eerst publiceerde. Meestal gebruikt in combinatie met 120V single phase of tot 240V single phase infrastructuur.
• IEC62196Type1CCS - Type 1 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 1-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om snel opladen met gelijkstroom mogelijk te maken.
• IEC62196Type2CableAttached - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als een kabel en stekker bevestigd aan het oplaadpunt.
• IEC62196Type2Outlet - Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als stopcontact in het oplaadpunt.
• IEC62196Type2CCS - Type 2 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 2-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om dc snel opladen mogelijk te maken.
• IEC62196Type3 - Type 3-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Scame genoemd naar de oorspronkelijke fabrikant. Meestal gebruikt in combinatie met tot 240V éénfase of tot 420V driefase infrastructuur.
• Chademo - CHAdeMO-connector genoemd naar een vereniging gevormd door de Tokyo Electric Power Company en industriële partners. Hierdoor wordt ook wel de TEPCO-connector genoemd. Het ondersteunt snel opladen via DC.
• IEC60309AC1PhaseBlue - Industriële blauwe connector is een connector die is gedefinieerd in de IEC 60309-standaard. Het wordt soms aangeduid als door een combinatie van de standaard, de kleur en het feit dat een eenfaseconnector is. De connector heeft meestal de configuratie 'P+N+E, 6h'.
• IEC60309DCWhite - Industriële witte connector is een DC-connector die is gedefinieerd in de IEC 60309-standaard.
• Tesla - De Tesla-connector is de regionaal specifieke Tesla Supercharger-connector. D.w.z. het verwijst naar de eigen connector van Tesla, soms aangeduid als Tesla Port meestal beperkt tot Noord-Amerika of het gewijzigde Type 2 (DC boven Type 2) in Europa.

Gebruiksvoorbeelden:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

Name	Type	Description
Chademo	string	CHAdeMO-connector genoemd naar een vereniging gevormd door de Tokyo Electric Power Company en industriële partners. Hierdoor wordt ook wel de TEPCO-connector genoemd. Het ondersteunt snel opladen via DC.
IEC60309AC1PhaseBlue	string	Industrial Blue-connector is een connector die is gedefinieerd in de IEC 60309-standaard. Het wordt soms aangeduid als door een combinatie van de standaard, de kleur en het feit dat een eenfaseconnector is. De connector heeft meestal de configuratie 'P+N+E, 6h'.
IEC60309DCWhite	string	Industrial White-connector is een DC-connector die is gedefinieerd in de IEC 60309-standaard.
IEC62196Type1	string	Type 1-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Yazaki genoemd naar de oorspronkelijke fabrikant of SAE J1772 naar de standaard die het eerst publiceerde. Meestal gebruikt in combinatie met 120V single phase of tot 240V single phase infrastructuur.
IEC62196Type1CCS	string	Op type 1 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 1-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om snel opladen met gelijkstroom mogelijk te maken.
IEC62196Type2CCS	string	Op type 2 gebaseerde combinatieconnector zoals gedefinieerd in de IEC 62196-3-standaard. De connector is gebaseerd op de Type 2-connector – zoals gedefinieerd in de IEC 62196-2-standaard – met twee extra gelijkstroomcontacten (DC) om dc snel opladen mogelijk te maken.
IEC62196Type2CableAttached	string	Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als een kabel en stekker bevestigd aan het oplaadpunt
IEC62196Type2Outlet	string	Type 2-connector zoals gedefinieerd in de IEC 62196-2-norm. Geleverd als stopcontact in het oplaadpunt.
IEC62196Type3	string	Type 3-connector zoals gedefinieerd in de IEC 62196-2-norm. Ook wel Scame genoemd naar de oorspronkelijke fabrikant. Meestal gebruikt in combinatie met tot 240V éénfase of tot 420V driefase infrastructuur.
StandardHouseholdCountrySpecific	string	Dit zijn de standaardconnectors voor een bepaalde regio. Ze zijn allemaal AC eenfase en de standaard spanning en standaard Amperage. Zie ook: Plug & socket types - World Standards
Tesla	string	De Tesla-connector is de regionaal specifieke Tesla Supercharger-connector. D.w.z. het verwijst naar de eigen connector van Tesla, soms aangeduid als Tesla Port meestal beperkt tot Noord-Amerika of het gewijzigde Type 2 (DC boven Type 2) in Europa.

Entity

Bron van het entiteitstype van het begrenzingsvak. Voor reverse-geocodering is dit altijd gelijk aan positie.

Name	Type	Description
position	string	Positie-entiteit

EntryPoint

Het toegangspunt voor de POI die wordt geretourneerd.

Name	Type	Description
position	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
type	EntryPointType	Het type toegangspunt. De waarde kan main of minor zijn.

EntryPointType

Het type toegangspunt. De waarde kan main of minor zijn.

Name	Type	Description
main	string
minor	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

GeographicEntityType

Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.

Name	Type	Description
Country	string	naam van land/regio
CountrySecondarySubdivision	string	Graafschap
CountrySubdivision	string	Staat of provincie
CountryTertiarySubdivision	string	Benoemd gebied
Municipality	string	Plaats/plaats
MunicipalitySubdivision	string	Sub-/superstad
Neighbourhood	string	Buurt
PostalCodeArea	string	Postcode/postcode

GeoJsonLineString

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

Name	Type	Description
coordinates	number[]	Coördinaten voor de GeoJson LineString geometrie.
type	string: LineString	Hiermee geeft u het GeoJSON type op. Moet een van de negen geldige GeoJSON-objecttypen zijn: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.

Geometry

Informatie over de geometrische vorm van het resultaat. Alleen aanwezig als u == Geografie typt.

Name	Type	Description
id	string	Geef deze door als geometryId aan de API Get Search Polygon om geometriegegevens voor dit resultaat op te halen.

LatLongPairAbbreviated

Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.

Name	Type	Description
lat	number	De eigenschap Breedtegraad
lon	number	De eigenschap Lengtegraad

LocalizedMapView

Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de weergaveparameter correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Name	Type	Description
AE	string	Verenigde Arabische Emiraten (Arabische weergave)
AR	string	Argentinië (Argentijnse weergave)
Auto	string	Retourneer de toewijzingsgegevens op basis van het IP-adres van de aanvraag.
BH	string	Bahrein (Arabische weergave)
IN	string	India (Indiase weergave)
IQ	string	Irak (Arabische weergave)
JO	string	Jordanië (Arabische weergave)
KW	string	Koeweit (Arabische weergave)
LB	string	Libanon (Arabische weergave)
MA	string	Marokko (Marokkaanse weergave)
OM	string	Oman (Arabische weergave)
PK	string	Pakistan (Pakistaanse weergave)
PS	string	Palestijnse Autoriteit (Arabische weergave)
QA	string	Qatar (Arabische weergave)
SA	string	Saoedi-Arabië (Arabische weergave)
SY	string	Syrië (Arabische weergave)
Unified	string	Geïntegreerde weergave (overige)
YE	string	Jemen (Arabische weergave)

MatchType

Typen overeenkomsten voor een zoekbewerking voor omgekeerde adressen.

Name	Type	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Openingstijden voor een POI (Points of Interest).

Name	Type	Description
mode	string	Waarde die in de aanvraag wordt gebruikt: none of 'nextSevenDays'
timeRanges	OperatingHoursTimeRange[]	Lijst met tijdsbereiken voor de komende 7 dagen

OperatingHoursRange

Openingstijden voor een POI (Nuttige plaatsen). De beschikbaarheid van bedrijfsuren varieert op basis van de beschikbare gegevens. Als dit niet wordt doorgegeven, wordt er geen informatie over de openingstijden geretourneerd. Ondersteunde waarde: nextSevenDays

Name	Type	Description
nextSevenDays	string	Toont de bedrijfsuren voor de volgende week, beginnend met de huidige dag in de lokale tijd van de POI.

OperatingHoursTime

Vertegenwoordigt een datum en tijd

Name	Type	Description
date	string	Geeft de huidige kalenderdatum in poi-tijdzone aan, bijvoorbeeld '02-2019-07'.
hour	integer	Uren zijn in de 24-uursnotatie in de lokale tijd van een POI; mogelijke waarden zijn 0 - 23.
minute	integer	Minuten bevinden zich in de lokale tijd van een POI; mogelijke waarden zijn 0 - 59.

OperatingHoursTimeRange

Open tijdsbereik voor een dag

Name	Type	Description
endTime	OperatingHoursTime	Het punt in het bereik van de komende 7 dagen waarop een bepaalde POI wordt gesloten, of het begin van het bereik als het vóór het bereik gesloten was.
startTime	OperatingHoursTime	Het punt in het komende 7 dagenbereik waarop een bepaalde POI wordt geopend, of het begin van het bereik als deze vóór het bereik is geopend.

PointOfInterest

Details van de geretourneerde POI, inclusief informatie zoals de naam, het telefoonnummer, het URL-adres en de classificaties.

Name	Type	Description
brands	Brand[]	Merkenmatrix. De naam van het merk voor de POI die wordt geretourneerd.
categories	string[]	Categorieënmatrix
categorySet	PointOfInterestCategorySet[]	De lijst met de meest specifieke POI-categorieën
classifications	Classification[]	Classificatiematrix
name	string	Naam van de eigenschap POI
openingHours	OperatingHours	Openingstijden voor een POI (Points of Interest).
phone	string	Eigenschap Telefoonnummer
url	string	Website-URL-eigenschap

PointOfInterestCategorySet

POI-categorie

Name	Type	Description
id	integer	Categorie-id

QueryType

Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.

Name	Type	Description
NEARBY	string	Search is uitgevoerd rond een bepaalde breedtegraad en lengtegraad met een gedefinieerde straal
NON_NEAR	string	Search is wereldwijd uitgevoerd, zonder vooringenomenheid ten opzichte van een bepaalde breedtegraad en lengtegraad, en zonder gedefinieerde radius

ResponseFormat

Gewenste indeling van het antwoord. De waarde kan json of xml zijn.

Name	Type	Description
json	string	De JavaScript Object Notation Data Interchange-indeling
xml	string	De uitbreidbare opmaaktaal

SearchAddressResult

Dit object wordt geretourneerd na een geslaagde Search aanroepen.

Name	Type	Description
results	SearchAddressResultItem[]	Een lijst met Search API-resultaten.
summary	SearchSummary	Samenvattingsobject voor een Search API-antwoord

SearchAddressResultItem

Resultaatobject voor een Search API-antwoord.

Name	Type	Description
address	Address	Het adres van het resultaat
addressRanges	AddressRanges	Beschrijft het adresbereik aan beide zijden van de straat voor een zoekresultaat. Coördinaten voor de begin- en eindlocatie van het adresbereik worden opgenomen.
dataSources	DataSources	Optionele sectie. Referentiegeometrie-id voor gebruik met de GET Search Polygon-API.
detourTime	integer	Omleidingstijd in seconden. Alleen geretourneerd voor aanroepen naar de api Search langs route.
dist	number	Rechte lijnafstand tussen het resultaat en de geobias-locatie in meters.
entityType	GeographicEntityType	Entiteitstype Geografie. Alleen aanwezig wanneer entityType is aangevraagd en beschikbaar is.
entryPoints	EntryPoint[]	Matrix van EntryPoints. Deze beschrijven de soorten ingangen die beschikbaar zijn op de locatie. Het type kan 'main' zijn voor hoofdingangen, zoals een voordeur, of een lobby, en 'secundair' voor zij- en achterdeuren.
id	string	Id-eigenschap
info	string	Informatie over de oorspronkelijke gegevensbron van het resultaat. Wordt gebruikt voor ondersteuningsaanvragen.
matchType	MatchType	Informatie over het type overeenkomst. Een van de volgende: AddressPoint HuisNummerRange Straat
poi	PointOfInterest	Details van de geretourneerde POI, inclusief informatie zoals de naam, het telefoonnummer, het URL-adres en de classificaties.
position	LatLongPairAbbreviated	Een locatie die wordt weergegeven als een breedtegraad en lengtegraad met korte namen 'lat' & 'lon'.
score	number	De waarde binnen een resultatenset om de relatieve overeenkomende score tussen resultaten aan te geven. U kunt dit gebruiken om te bepalen dat resultaat x twee keer zo waarschijnlijk is als relevant als resultaat y als de waarde van x 2x de waarde van y is. De waarden variëren per query en zijn alleen bedoeld als een relatieve waarde voor één resultatenset.
type	SearchAddressResultType	Een van de volgende: POI Straat Geografie Puntadres Adresbereik Straat kruisen
viewport	BoundingBox	De viewport die het resultaat bedekt dat wordt vertegenwoordigd door de coördinaten linksboven en rechtsonder van de viewport.

SearchAddressResultType

Een van de volgende:

• POI
• Straat
• Geografie
• Puntadres
• Adresbereik
• Straat kruisen

Name	Type	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchAlongRouteRequest

Dit type vertegenwoordigt de aanvraagbody voor de Search Langs route-service.

Name	Type	Description
route	GeoJsonLineString	Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946 voor meer informatie.

SearchSummary

Samenvattingsobject voor een Search API-antwoord.

Name	Type	Description
fuzzyLevel	integer	Het maximale fuzzy-niveau dat is vereist om resultaten op te geven.
geoBias	LatLongPairAbbreviated	Indicatie wanneer de interne zoekmachine een georuimtelijke bias heeft toegepast om de rangschikking van resultaten te verbeteren. In sommige methoden kan dit worden beïnvloed door de lat- en lon-parameters in te stellen, indien beschikbaar. In andere gevallen is het puur intern.
limit	integer	Maximum aantal antwoorden dat wordt geretourneerd
numResults	integer	Het aantal resultaten in het antwoord.
offset	integer	De begin offset van de geretourneerde Resultaten binnen de volledige resultatenset.
query	string	De queryparameter die is gebruikt om deze zoekresultaten te produceren.
queryTime	integer	Tijd besteed aan het oplossen van de query, in milliseconden.
queryType	QueryType	Het type query dat wordt geretourneerd: IN DE BUURT of NON_NEAR.
totalResults	integer	Het totale aantal gevonden resultaten.