Search - Get Search Address Reverse Batch

API Batch inverse de l’adresse de recherche

S’applique à : voir les niveaux tarifaires.

L’API Batch d’adresses de recherche envoie des lots de requêtes à l’API inverse de l’adresse de recherche à l’aide d’un seul appel d’API. Vous pouvez appeler l’API Batch inverse de l’adresse de recherche pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter jusqu’à 10 000 requêtes et de synchroniser l’API jusqu’à 100 requêtes.

Envoyer une demande de lot synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Envoyer une demande de lot asynchrone

L’API asynchrone est appropriée pour traiter de grands volumes de requêtes de recherche relativement complexes

  • Il permet la récupération des résultats dans un appel distinct (plusieurs téléchargements sont possibles).
  • L’API asynchrone est optimisée pour la fiabilité et n’est pas censée s’exécuter dans un délai d’expiration.
  • Le nombre d’éléments de lot est limité à 10 000 pour cette API.

Lorsque vous effectuez une requête à l’aide d’une requête asynchrone, par défaut, le service retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. Les réponses asynchrones sont stockées pendant 14 jours. L’URL de redirection retourne une réponse 404 si elle est utilisée après la période d’expiration.

Notez que la demande de lot asynchrone est une requête de longue durée. Voici une séquence d’opérations classique :

  1. Le client envoie une requête Batch POST d’adresse de recherche à Azure Maps

  2. Le serveur répond avec l’une des opérations suivantes :

    HTTP - La 202 Accepted requête Batch a été acceptée.

    HTTP Error : une erreur a été produite lors du traitement de votre requête Batch. Il peut s’agir d’un 400 Bad Request code d’état ou d’un autre Error code d’état.

  3. Si la demande de lot a été acceptée avec succès, l’en-tête Location de la réponse contient l’URL pour télécharger les résultats de la demande de lot. Cet URI d’état ressemble à ce qui suit :

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Le client émet une GET demande sur l’URL de téléchargement obtenue à l’étape 3 pour télécharger les résultats du lot.

Corps POST pour la requête Batch

Pour envoyer les requêtes inverses d’adresse de recherche , vous allez utiliser une POST requête dans laquelle le corps de la requête contiendra le batchItems tableau au json format et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 5 requêtes inverses d’adresse de recherche :

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Une requête inverse d’adresse de recherche dans un lot n’est qu’une URL partielle sans le protocole, l’URL de base, le chemin, la version d’API et la clé d’abonnement. Il peut accepter l’un des paramètres d’URIinverse de l’adresse de recherche pris en charge. Les valeurs de chaîne de la requête inverse de l’adresse de recherche doivent être correctement échapées (par exemple, « le caractère doit être échapré avec \ ) et il doit également être correctement codé sur l’URL.

L’API asynchrone permet à l’appelant de traiter jusqu’à 10 000 requêtes et d’API de synchronisation jusqu’à 100 requêtes, et le lot doit contenir au moins 1 requête.

Télécharger les résultats de lot asynchrones

Pour télécharger les résultats de lot asynchrones, vous émettrez une GET demande sur le point de terminaison de téléchargement par lot. Cette URL de téléchargement peut être obtenue à partir de l’en-tête Location d’une demande de lot réussie POST et ressemble à ce qui suit :

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Voici la séquence classique d’opérations pour télécharger les résultats du lot :

  1. Le client envoie une GET requête à l’aide de l’URL de téléchargement.

  2. Le serveur répond avec l’une des opérations suivantes :

    HTTP 202 Accepted - La requête Batch a été acceptée, mais elle est toujours traitée. Réessayez dans un certain temps.

    HTTP 200 OK - Requête Batch correctement traitée. Le corps de la réponse contient tous les résultats de lot.

Modèle de réponse par lot

Le contenu de données retourné est similaire pour les demandes asynchrones et de synchronisation. Lors du téléchargement des résultats d’une requête de lot asynchrone, si le traitement du lot a terminé, le corps de la réponse contient la réponse par lot. Cette réponse de lot contient un summary composant qui indique le totalRequests composant qui faisait partie de la requête de lot d’origine et successfulRequestsc’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un batchItems tableau qui contient une réponse pour chaque requête et chaque requête dans la requête de lot. Le batchItems fichier contiendra les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément dans batchItems contient et response champsstatusCode. batchItems Chacun response est de l’un des types suivants :

  • SearchAddressReverseResponse - Si la requête s’est terminée avec succès.

  • Error - Si la requête a échoué. La réponse contient une code et une message dans ce cas.

Voici un exemple de réponse Batch avec 2 résultats réussis et 1 ayant échoué :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Paramètres URI

Name In Required Type Description
format
path True
  • string

ID de lot pour l’interrogation de l’opération.

api-version
query True
  • string

Numéro de version de l’API Azure Maps.

En-tête de la demande

Name Required Type Description
x-ms-client-id
  • string

Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour utiliser la sécurité Azure AD dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Name Type Description
200 OK

OK

202 Accepted

Pris en charge uniquement pour la requête asynchrone. Demande acceptée : la demande a été acceptée pour le traitement. Utilisez l’URL dans l’en-tête d’emplacement pour réessayer ou accéder aux résultats.

Headers

  • Location: string
Other Status Codes

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut être autorisé via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser les applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer quelle ressource Azure Maps l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.

Il Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active Directory. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, KITS SDK Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’utilisation.

  • Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

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

Il s’agit d’une clé partagée provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de Kits de développement logiciel (SDK) PowerShell, CLI, Azure ou REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, notre recommandation consiste à utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
In: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération De liste SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, Azure SDK ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et à un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation consiste à configurer une liste spécifique d’origines autorisées sur la ressource de compte map pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
In: header

Exemples

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivision": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivision": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Définitions

Address

Adresse du résultat

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

BoundingBox

Fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

Brand

Marque associée au POI

Classification

Classification du poI retourné

ClassificationName

Nom de la classification

DataSources

Section facultative. ID de référence à utiliser avec l’API Get Search Polygon .

Entity

Source de type d’entité de la zone englobante. Pour le géocodage inverse, cela est toujours égal à la position.

EntryPoint

Point d’entrée du poI retourné.

EntryPointType

Type de point d’entrée. La valeur peut être principale ou mineure.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

GeographicEntityType

Type d’entité geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Geometry

Informations sur la forme géométrique du résultat. Présente uniquement si type == Geography.

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts 'lat' & 'lon'.

MatchType

Types de correspondance pour une opération de recherche d’adresse inverse.

OperatingHours

Heures d’ouverture d’un POI (Points d’intérêt).

OperatingHoursTime

Représente une date et une heure

OperatingHoursTimeRange

Intervalle de temps ouvert pour un jour

PointOfInterest

Détails du point de terminaison retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications.

PointOfInterestCategorySet

Catégorie POI

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

Response

Résultat de la requête. SearchAddressResponse si la requête s’est terminée correctement, ErrorResponse sinon.

ReverseSearchAddressBatchItem

Élément retourné à partir de l’appel du service Batch inversé d’adresse de recherche.

ReverseSearchAddressBatchProcessResult

Cet objet est retourné par un appel de service Batch inversé d’adresse de recherche réussi.

SearchAddressResultItem

Objet Result pour une réponse d’API de recherche.

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Géographie
  • Adresse exacte
  • Plage d’adresses
  • Croisement
SearchSummary

Objet summary pour une réponse d’API de recherche.

Summary

Résumé des résultats de la demande de lot

Address

Adresse du résultat

Name Type Description
boundingBox

Zone englobante de l’emplacement.

buildingNumber
  • string

Numéro de bâtiment sur la rue. DÉCONSEILLÉ, utilisez plutôt streetNumber.

country
  • string

Nom du pays

countryCode
  • string

Pays (Remarque : Il s’agit d’un code à deux lettres, et non d’un nom de pays.)

countryCodeISO3
  • string

Code de pays ISO alpha-3

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

State or Province

countrySubdivisionName
  • string

Nom complet d’un premier niveau de hiérarchie administrative de pays. Ce champ apparaît uniquement dans le cas où countrySubdivision est présenté sous une forme abrégée. Uniquement pris en charge pour les États-Unis, le Canada et le Royaume-Uni.

countryTertiarySubdivision
  • string

Zone nommée

crossStreet
  • string

Nom de la rue croisée.

extendedPostalCode
  • string

Code postal étendu (la disponibilité dépend de la région).

freeformAddress
  • string

Ligne d’adresse mise en forme selon les règles de mise en forme du pays d’origine d’un résultat, ou dans le cas d’un pays, son nom de pays complet.

localName
  • string

Composant d’adresse qui représente le nom d’une zone géographique ou d’une localité qui regroupe un certain nombre d’objets adressables à des fins d’adressage, sans être une unité administrative. Ce champ est utilisé pour générer la freeformAddress propriété.

municipality
  • string

Ville / Ville

municipalitySubdivision
  • string

Sub / Super City

postalCode
  • string

Postal Code / Zip Code

routeNumbers
  • string[]

Codes utilisés pour identifier sans ambiguïté la rue

street
  • string

Nom de la rue. DÉCONSEILLÉ, utilisez streetName à la place.

streetName
  • string

Nom de la rue.

streetNameAndNumber
  • string

Nom et numéro de la rue.

streetNumber
  • string

Numéro de bâtiment sur la rue.

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

Name Type Description
from

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts « lat » & 'lon'.

rangeLeft
  • string

Plage d’adresses sur le côté gauche de la rue.

rangeRight
  • string

Plage d’adresses sur le côté droit de la rue.

to

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts « lat » & 'lon'.

BoundingBox

Fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

Name Type Description
btmRightPoint

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts « lat » & 'lon'.

topLeftPoint

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts « lat » & 'lon'.

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

Name Type Description
entity

Source de type d’entité de la zone englobante. Pour le géocodage inverse, cela est toujours égal à la position.

northEast
  • string

Latitude nord-est, coordonnée de longitude de la zone englobante en tant que flotteurs séparés par des virgules

southWest
  • string

Latitude sud-ouest, coordonnée de longitude de la zone englobante en tant que flotteurs séparés par des virgules

Brand

Marque associée au POI

Name Type Description
name
  • string

Nom de la marque

Classification

Classification du poI retourné

Name Type Description
code
  • string

Propriété code

names

Tableau de noms

ClassificationName

Nom de la classification

Name Type Description
name
  • string

Nom de la propriété

nameLocale
  • string

Name Locale, propriété

DataSources

Section facultative. ID de référence à utiliser avec l’API Get Search Polygon .

Name Type Description
geometry

Informations sur la forme géométrique du résultat. Présente uniquement si type == Geography.

Entity

Source de type d’entité de la zone englobante. Pour le géocodage inverse, cela est toujours égal à la position.

Name Type Description
position
  • string

Position de l’entité

EntryPoint

Point d’entrée du poI retourné.

Name Type Description
position

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts « lat » & 'lon'.

type

Type de point d’entrée. La valeur peut être principale ou mineure.

EntryPointType

Type de point d’entrée. La valeur peut être principale ou mineure.

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Name Type Description
info
  • object

Informations supplémentaires.

type
  • string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Name Type Description
additionalInfo

Informations supplémentaires sur l’erreur.

code
  • string

Code d'erreur.

details

Détails de l’erreur.

message
  • string

Message d’erreur.

target
  • string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Name Type Description
error

Objet d’erreur.

GeographicEntityType

Type d’entité geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Name Type Description
Country
  • string

Nom du pays

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

State or Province

CountryTertiarySubdivision
  • string

Zone nommée

Municipality
  • string

Ville / Ville

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Quartier

PostalCodeArea
  • string

Postal Code / Zip Code

Geometry

Informations sur la forme géométrique du résultat. Présente uniquement si type == Geography.

Name Type Description
id
  • string

Transmettez-le en tant que geometryId à l’API Get Search Polygon pour extraire des informations géométriques pour ce résultat.

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts 'lat' & 'lon'.

Name Type Description
lat
  • number

Latitude, propriété

lon
  • number

Longitude, propriété

MatchType

Types de correspondance pour une opération de recherche d’adresse inverse.

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Heures d’ouverture d’un POI (Points d’intérêt).

Name Type Description
mode
  • string

Valeur utilisée dans la demande : aucun ou « nextSevenDays »

timeRanges

Liste des intervalles de temps pour les 7 prochains jours

OperatingHoursTime

Représente une date et une heure

Name Type Description
date
  • string

Représente la date de calendrier actuelle dans le fuseau horaire poI, par exemple « 2019-02-07 ».

hour
  • integer

Les heures sont au format 24 heures dans l’heure locale d’un POI ; les valeurs possibles sont 0 à 23.

minute
  • integer

Les minutes sont dans l’heure locale d’un POI ; les valeurs possibles sont 0 à 59.

OperatingHoursTimeRange

Intervalle de temps ouvert pour un jour

Name Type Description
endTime

Point dans la plage de 7 jours suivant lorsqu’un POI donné est fermé ou le début de la plage s’il a été fermé avant la plage.

startTime

Point dans la plage de 7 jours suivant lorsqu’un POI donné est ouvert ou le début de la plage s’il a été ouvert avant la plage.

PointOfInterest

Détails du point de terminaison retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications.

Name Type Description
brands

Tableau de marques. Nom de la marque pour le POI retourné.

categories
  • string[]

Tableau catégories

categorySet

Liste des catégories de poI les plus spécifiques

classifications

Tableau de classification

name
  • string

Nom de la propriété POI

openingHours

Heures d’ouverture d’un POI (Points d’intérêt).

phone
  • string

Propriété numéro de téléphone

url
  • string

Propriété URL du site web

PointOfInterestCategorySet

Catégorie POI

Name Type Description
id
  • integer

ID de la catégorie

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

Name Type Description
NEARBY
  • string

La recherche a été effectuée autour d’une certaine latitude et longitude avec un rayon défini

NON_NEAR
  • string

La recherche a été effectuée globalement, sans biaiser une certaine latitude et longitude, et aucun rayon défini

Response

Résultat de la requête. SearchAddressResponse si la requête s’est terminée correctement, ErrorResponse sinon.

Name Type Description
error

Objet d’erreur.

results

Liste des résultats de l’API de recherche.

summary

Objet Summary pour une réponse d’API de recherche

ReverseSearchAddressBatchItem

Élément retourné à partir de l’appel du service Batch inversé d’adresse de recherche.

Name Type Description
response

Résultat de la requête. SearchAddressReverseResponse si la requête s’est terminée correctement, ErrorResponse sinon.

statusCode
  • integer

Code d’état de la requête HTTP.

ReverseSearchAddressBatchProcessResult

Cet objet est retourné par un appel de service Batch inversé d’adresse de recherche réussi.

Name Type Description
batchItems

Tableau contenant les résultats du lot.

summary

Résumé des résultats de la demande de lot

SearchAddressResultItem

Objet Result pour une réponse d’API de recherche.

Name Type Description
address

Adresse du résultat

addressRanges

Décrit la plage d’adresses des deux côtés de la rue pour obtenir un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

dataSources

Section facultative. ID geometry de référence à utiliser avec l’API Get Search Polygon .

detourTime
  • integer

Délai de détour en secondes. Retourné uniquement pour les appels à l’API Search Along Route.

dist
  • number

Distance droite entre le résultat et l’emplacement des géobias en mètres.

entityType

Type d’entité geography. Présente uniquement lorsque entityType a été demandé et est disponible.

entryPoints

Tableau de points d’entrée. Ceux-ci décrivent les types d’entrées disponibles à l’emplacement. Le type peut être « principal » pour les entrées principales telles qu’une porte d’entrée, ou un hall d’entrée, et « mineur », pour les portes latérales et arrière.

id
  • string

Id, propriété

info
  • string

Informations sur la source de données d’origine du résultat. Utilisé pour les demandes de support.

matchType

Informations sur le type de correspondance.

Valeurs possibles :

  • AddressPoint
  • HouseNumberRange
  • Rue
poi

Détails du point de terminaison retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications.

position

Emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts 'lat' & 'lon'.

score
  • number

Valeur dans un jeu de résultats pour indiquer le score de correspondance relatif entre les résultats. Vous pouvez l’utiliser pour déterminer que le résultat x est deux fois plus susceptible d’être aussi pertinent que le résultat y si la valeur de x est 2x la valeur y. Les valeurs varient entre les requêtes et ne sont destinées qu’à une valeur relative pour un jeu de résultats.

type

Valeurs possibles :

  • POI
  • Rue
  • Géographie
  • Adresse exacte
  • Plage d’adresses
  • Croisement
viewport

Fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Géographie
  • Adresse exacte
  • Plage d’adresses
  • Croisement
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchSummary

Objet summary pour une réponse d’API de recherche.

Name Type Description
fuzzyLevel
  • integer

Niveau fuzzy maximal requis pour fournir les résultats.

geoBias

Indication lorsque le moteur de recherche interne a appliqué un biais géospatial pour améliorer le classement des résultats. Dans certaines méthodes, cela peut être affecté en définissant les paramètres lat et lon, le cas échéant. Dans d’autres cas, il est purement interne.

limit
  • integer

Nombre maximal de réponses qui seront retournées

numResults
  • integer

Nombre de résultats dans la réponse.

offset
  • integer

Décalage de départ des résultats retournés dans le jeu de résultats complet.

query
  • string

Paramètre de requête utilisé pour produire ces résultats de recherche.

queryTime
  • integer

Temps passé à résoudre la requête, en millisecondes.

queryType

Type de requête retourné : NEARBY ou NON_NEAR.

totalResults
  • integer

Nombre total de résultats trouvés.

Summary

Résumé des résultats de la demande de lot

Name Type Description
successfulRequests
  • integer

Nombre de demandes réussies dans le lot

totalRequests
  • integer

Nombre total de demandes dans le lot