Partager via

Search - Get Search Fuzzy Batch

  • Référence
Service:
Maps
Version d'API:
1.0

Utilisez pour envoyer un lot de requêtes à l’api Recherche fuzzy dans une requête asynchrone unique.
L’API Get Search Fuzzy Batch est et la requête HTTP GET qui envoie des lots de requêtes à Recherche’API approximative dans un seul appel d’API asynchrone. Vous pouvez appeler Recherche’API Fuzzy Batch pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter par lot 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 demandes de 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’est plus possible 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 demande prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

POST https://atlas.microsoft.com/search/fuzzy/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 gros volumes de demandes 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 avoir un délai d’expiration.
  • Le nombre d’éléments de lot est limité à 10 000 pour cette API.

Lorsque vous effectuez une demande à 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 requête par lot asynchrone est une opération de longue durée. Voici une séquence classique d’opérations :

  1. Le client envoie une Recherche demande de lot POST approximative à Azure Maps.
POST https://atlas.microsoft.com/search/fuzzy/batch/json?api-version=1.0&subscription-key={subscription-key}

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

    HTTP 202 Accepted : la requête Batch a été acceptée.

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

  2. Si la demande de lot a été acceptée avec succès, l’en-tête Location de la réponse contient l’URL permettant de télécharger les résultats de la demande de lot. Cet URI status se présente comme suit :

    GET https://atlas.microsoft.com/search/fuzzy/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 demande de lot

Pour envoyer les requêtes approximatives de recherche , vous utiliserez une POST requête où le corps de la demande 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 approximatives de recherche :

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Une requête approximative de recherche dans un lot n’est qu’une URL partielle sans le protocole, l’URL de base, le chemin, la version de l’API et la clé d’abonnement. Il peut accepter n’importe quel paramètre d’URIde recherche approximative pris en charge. Les valeurs de chaîne dans la requête fuzzy de recherche doivent être correctement placées dans une séquence d’échappement (par exemple, « caractère doit être placé dans une séquence d’échappement avec \ ) et elles doivent également être correctement encodées dans l’URL.

L’API asynchrone permet à l’appelant de traiter par lot jusqu’à 10 000 requêtes et de synchroniser l’API 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 du lot asynchrone, vous allez envoyer une GET requête au point de terminaison de téléchargement par lots. 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 se présente comme suit :

https://atlas.microsoft.com/search/fuzzy/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 en cours de traitement. Réessayez dans un certain temps.

    HTTP 200 OK : requête Batch traitée avec succès. Le corps de la réponse contient tous les résultats du lot.

Modèle de réponse par lot

Le contenu des données retournées est similaire pour les demandes asynchrones et de synchronisation. Lors du téléchargement des résultats d’une demande de lot asynchrone, si le traitement du lot est terminé, le corps de la réponse contient la réponse par lot. Cette réponse par lot contient un summary composant qui indique qui totalRequests faisait partie de la demande de lot d’origine, c’est-à-dire successfulRequestsles 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 dans la demande de lot. Contient batchItems les résultats exactement dans le même ordre que celui que les requêtes d’origine ont été envoyées dans la demande de lot. Chaque élément dans batchItems contient statusCode des champs et response . Chaque response dans batchItems est de l’un des types suivants :

  • SearchAddressResult - Si la requête s’est terminée correctement.

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

Voici un exemple de réponse par lot avec 2 réussites et 1 échec :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "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/fuzzy/batch/{format}?api-version=1.0

Paramètres URI

Nom Dans Obligatoire 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

Nom Obligatoire Type Description
x-ms-client-id

string

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

Réponses

Nom Type Description
200 OK

SearchAddressBatchProcessResult

Ok
202 Accepted

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

En-têtes

Location: string
Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. 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 ressource ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès 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 des 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. Vous pouvez l’acquérir à partir de l’API de gestion maps .
  • est Authorization URL spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
  • 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 une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
  • Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API 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é master dans le compte dans lequel elle est émise.

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

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure 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 à la ou les régions d’utilisation du 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, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

A Search Fuzzy Batch API GET call containing 5 Search Fuzzy API queries

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "atm",
          "queryType": "NON_NEAR",
          "queryTime": 5,
          "numResults": 5,
          "offset": 0,
          "totalResults": 262,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/3656546",
            "score": 2.671,
            "dist": 1336.1815386162032,
            "info": "search:ta:840539002005905-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "14808",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "14808 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63229,
              "lon": -122.14232
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63319,
                "lon": -122.14365
              },
              "btmRightPoint": {
                "lat": 47.63139,
                "lon": -122.14099
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63154,
                  "lon": -122.1423
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/8673325",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840539002022072-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "Northeast 24Th Street",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736315",
            "score": 2.671,
            "dist": 864.7591776519859,
            "info": "search:ta:840539002187855-US",
            "poi": {
              "name": "US Bank ATM-MONEYPASS",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15521",
              "streetName": "Bel Red Rd",
              "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue",
              "municipality": "Redmond, Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525501",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63259,
              "lon": -122.1328
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63349,
                "lon": -122.13413
              },
              "btmRightPoint": {
                "lat": 47.63169,
                "lon": -122.13147
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.63255,
                  "lon": -122.13275
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/3656412",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001998867-US",
            "poi": {
              "name": "US Bank ATM NATIONAL ASSOCIATION",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/2736876",
            "score": 2.67,
            "dist": 2140.198538580941,
            "info": "search:ta:840539001396789-US",
            "poi": {
              "name": "US Bank ATM",
              "phone": "+(1)-(800)-8722657",
              "brands": [
                {
                  "name": "US Bank ATM"
                }
              ],
              "categorySet": [
                {
                  "id": 7397
                }
              ],
              "url": "www.usbank.com",
              "classifications": [
                {
                  "code": "CASH_DISPENSER",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "cash dispenser"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1128",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62069,
              "lon": -122.13213
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62159,
                "lon": -122.13346
              },
              "btmRightPoint": {
                "lat": 47.61979,
                "lon": -122.1308
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62069,
                  "lon": -122.13236
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "statue of liberty",
          "queryType": "NON_NEAR",
          "queryTime": 37,
          "numResults": 2,
          "offset": 0,
          "totalResults": 18,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/9189660",
            "score": 6.942,
            "info": "search:ta:840369001174316-US",
            "poi": {
              "name": "Statue of Liberty",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "monument"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "municipalitySubdivision": "New York",
              "municipality": "New York",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10004",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "New York, NY 10004",
              "localName": "New York",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.68955,
              "lon": -74.04483
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.69045,
                "lon": -74.04602
              },
              "btmRightPoint": {
                "lat": 40.68865,
                "lon": -74.04364
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.69001,
                  "lon": -74.04683
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/3264566",
            "score": 6.942,
            "info": "search:ta:840019000670588-US",
            "poi": {
              "name": "Statue of Liberty",
              "phone": "+(1)-(205)-9700251",
              "categorySet": [
                {
                  "id": 7376003
                }
              ],
              "url": "www.1bsa.org",
              "classifications": [
                {
                  "code": "IMPORTANT_TOURIST_ATTRACTION",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "important tourist attraction"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "516",
              "streetName": "Liberty Pkwy",
              "municipalitySubdivision": "Vestavia Hills",
              "municipality": "Vestavia Hills, Birmingham",
              "countrySecondarySubdivision": "Jefferson",
              "countryTertiarySubdivision": "Leeds",
              "countrySubdivisionCode": "AL",
              "postalCode": "35242",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242",
              "localName": "Vestavia Hills",
              "countrySubdivisionName": "Alabama"
            },
            "position": {
              "lat": 33.48234,
              "lon": -86.70719
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 33.48324,
                "lon": -86.70827
              },
              "btmRightPoint": {
                "lat": 33.48144,
                "lon": -86.70611
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 33.48129,
                  "lon": -86.7065
                }
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "starbucks",
          "queryType": "NON_NEAR",
          "queryTime": 35,
          "numResults": 10,
          "offset": 0,
          "totalResults": 17,
          "fuzzyLevel": 1,
          "geoBias": {
            "lat": 47.639769,
            "lon": -122.128362
          }
        },
        "results": [
          {
            "type": "POI",
            "id": "US/POI/p0/153678",
            "score": 2.671,
            "dist": 1206.8488178244172,
            "info": "search:ta:840531000006554-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8695816",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15000",
              "streetName": "NE 24th St",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980525522",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15000 NE 24th St, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63265,
              "lon": -122.14052
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63355,
                "lon": -122.14185
              },
              "btmRightPoint": {
                "lat": 47.63175,
                "lon": -122.13919
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14056
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14058
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.63156,
                  "lon": -122.14048
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.6324,
                  "lon": -122.13938
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152316",
            "score": 2.67,
            "dist": 2315.294397491255,
            "info": "search:ta:840539000484552-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-6436471",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15097",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15600",
              "streetName": "NE 8th St",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98008",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61896,
              "lon": -122.12945
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61986,
                "lon": -122.13078
              },
              "btmRightPoint": {
                "lat": 47.61806,
                "lon": -122.12812
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.619,
                  "lon": -122.12945
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167545",
            "score": 2.67,
            "dist": 1979.2222952267998,
            "info": "search:ta:840539001950429-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-7470690",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1350",
              "streetName": "156th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62212,
              "lon": -122.13179
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62302,
                "lon": -122.13312
              },
              "btmRightPoint": {
                "lat": 47.62122,
                "lon": -122.13046
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62213,
                  "lon": -122.13236
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168519",
            "score": 2.67,
            "dist": 2490.3337046455963,
            "info": "search:ta:840539001015090-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-4556500",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "https://www.starbucks.com/store-locator/store/15901",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "1645",
              "streetName": "140th Ave NE",
              "municipalitySubdivision": "Crossroads, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98005",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62626,
              "lon": -122.15487
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62716,
                "lon": -122.1562
              },
              "btmRightPoint": {
                "lat": 47.62536,
                "lon": -122.15354
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.62645,
                  "lon": -122.15446
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.62579,
                  "lon": -122.15377
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/152428",
            "score": 2.668,
            "dist": 3529.7080738812224,
            "info": "search:ta:840539001033722-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-3789496",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "180",
              "streetName": "148th Ave SE",
              "municipalitySubdivision": "West Lake Hills, Bellevue",
              "municipality": "Bellevue",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98007",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007",
              "localName": "Bellevue",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.60901,
              "lon": -122.14
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.60991,
                "lon": -122.14133
              },
              "btmRightPoint": {
                "lat": 47.60811,
                "lon": -122.13867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.60901,
                  "lon": -122.14008
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167147",
            "score": 2.668,
            "dist": 3479.393294615887,
            "info": "search:ta:840539000326896-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8619198",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7425",
              "streetName": "166th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526288",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67055,
              "lon": -122.12001
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67145,
                "lon": -122.12135
              },
              "btmRightPoint": {
                "lat": 47.66965,
                "lon": -122.11867
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67069,
                  "lon": -122.11889
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153695",
            "score": 2.667,
            "dist": 3622.441074618729,
            "info": "search:ta:840531000006551-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8822881",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/store/15022",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "7625",
              "streetName": "170th Ave NE",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980520910",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67086,
              "lon": -122.11392
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67176,
                "lon": -122.11526
              },
              "btmRightPoint": {
                "lat": 47.66996,
                "lon": -122.11258
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.67073,
                  "lon": -122.1135
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/167420",
            "score": 2.667,
            "dist": 3818.293513029088,
            "info": "search:ta:840539000640782-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8853323",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "17246",
              "streetName": "Redmond Way",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980524403",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "17246 Redmond Way, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67174,
              "lon": -122.10976
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67264,
                "lon": -122.1111
              },
              "btmRightPoint": {
                "lat": 47.67084,
                "lon": -122.10842
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.6706,
                  "lon": -122.11026
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p0/153686",
            "score": 2.666,
            "dist": 4009.922205147074,
            "info": "search:ta:840531000006548-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8859590",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "15738",
              "streetName": "Redmond Way Pad 3 Redmond Center",
              "municipalitySubdivision": "Redmond",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980523873",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052",
              "localName": "Redmond",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.67583,
              "lon": -122.12877
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.67673,
                "lon": -122.13011
              },
              "btmRightPoint": {
                "lat": 47.67493,
                "lon": -122.12743
              }
            },
            "entryPoints": [
              {
                "type": "minor",
                "position": {
                  "lat": 47.67456,
                  "lon": -122.12887
                }
              },
              {
                "type": "main",
                "position": {
                  "lat": 47.67668,
                  "lon": -122.12829
                }
              }
            ]
          },
          {
            "type": "POI",
            "id": "US/POI/p1/168511",
            "score": 2.666,
            "dist": 3987.80992387863,
            "info": "search:ta:840531000006669-US",
            "poi": {
              "name": "Starbucks",
              "phone": "+(1)-(425)-8818265",
              "brands": [
                {
                  "name": "Starbucks"
                }
              ],
              "categorySet": [
                {
                  "id": 9376006
                }
              ],
              "url": "www.starbucks.com/site-selector",
              "classifications": [
                {
                  "code": "CAFE_PUB",
                  "names": [
                    {
                      "nameLocale": "en-US",
                      "name": "coffee shop"
                    },
                    {
                      "nameLocale": "en-US",
                      "name": "café/pub"
                    }
                  ]
                }
              ]
            },
            "address": {
              "streetNumber": "6617",
              "streetName": "132Nd Ave Ne Bridle Trails Shopping Center",
              "municipalitySubdivision": "Kirkland, Bridle Trails",
              "municipality": "Kirkland",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98033",
              "extendedPostalCode": "980338234",
              "countryCode": "US",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033",
              "localName": "Kirkland",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.66514,
              "lon": -122.16599
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.66604,
                "lon": -122.16733
              },
              "btmRightPoint": {
                "lat": 47.66424,
                "lon": -122.16465
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.666,
                  "lon": -122.16669
                }
              },
              {
                "type": "minor",
                "position": {
                  "lat": 47.66553,
                  "lon": -122.16405
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  }
}
Code d’état:
202

Définitions

Nom Description
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

La 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 POINT d’identification retourné
ClassificationName

Nom de la classification
DataSources

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

Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
EntryPoint

Point d’entrée du POI retourné.
EntryPointType

Type de point d’entrée. La valeur peut être main 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ésent uniquement si type == Geography.
LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.
OperatingHours

Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.
OperatingHoursTime

Représente une date et une heure
OperatingHoursTimeRange

Intervalle de temps ouvert pour un jour
PointOfInterest

Détails des poI retournés, notamment des 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. SearchAddressResult si la requête s’est terminée correctement, Sinon, ErrorResponse.
SearchAddressBatchItem

Élément retourné par Recherche’appel de service Address Batch.
SearchAddressBatchProcessResult

Cet objet est retourné à partir d’un appel de service Recherche Address Batch réussi.
SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.
SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
SearchSummary

Objet Summary pour une réponse d’API Recherche.
Summary

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

Address

Adresse du résultat

Nom Type Description
boundingBox

BoundingBoxCompassNotation

Zone englobante de l’emplacement.
buildingNumber

string

Numéro d’immeuble dans la rue. DEPRECATED, utilisez plutôt streetNumber.
country

string

nom du pays/de la région
countryCode

string

Pays (Remarque : il s’agit d’un code à deux lettres, et non d’un nom de pays/région.)
countryCodeISO3

string

Code de pays ISO alpha-3
countrySecondarySubdivision

string

County
countrySubdivision

string

State or Province
countrySubdivisionCode

string

countrySubdivisionCode préfixé par countryCode ( countryCode-countrySubdivisionCode ) et le trait d’union forme le code ISO 3166-2. Exemples : TX pour le Texas, SCT pour l’Écosse et ON pour l’Ontario.
countrySubdivisionName

string

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

string

Zone nommée
crossStreet

string

Nom de la rue traversé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/région d’origine d’un Result, ou dans le cas d’un pays/région, son nom complet de pays/région.
localName

string

Composant d’adresse qui représente le nom d’une zone géographique ou d’une localité qui regroupe plusieurs objets adressables à des fins d’adressage, sans être une unité administrative. Ce champ est utilisé pour générer la freeformAddress propriété. localName représente la municipalité postale. Selon l’emplacement, localName est le nom communément connu d’une ville ou d’une ville. Pour le nom communément connu d’une ville ou d’une ville, utilisez localName au lieu de municipality.
municipality

string

Ville/ Ville
Remarque : municipality représente la municipalité résidentielle. Selon l’emplacement, la municipality valeur peut différer du nom communément connu d’une ville ou d’une ville. Pour le nom communément connu de la ville ou de la ville, il est suggéré d’utiliser la localName valeur à la place de la municipality valeur.
municipalitySubdivision

string

Sub / Super City
neighbourhood

string

Un quartier est une zone géographiquement localisée au sein d’une ville avec des caractéristiques distinctives et des interactions sociales entre les habitants.
postalCode

string

Postal Code / Zip Code
routeNumbers

string[]

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

string

Nom de la rue. DEPRECATED, utilisez streetName à la place.
streetName

string

Nom de la rue.
streetNameAndNumber

string

Nom et numéro de la rue.
streetNumber

string

Numéro d’immeuble dans 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.

Nom Type Description
from

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des 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

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBox

La 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.

Nom Type Description
btmRightPoint

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
topLeftPoint

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

Nom Type Description
entity

Entity

Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
northEast

string

Latitude nord-est, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules
southWest

string

Latitude sud-ouest, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules

Brand

Marque associée au POI

Nom Type Description
name

string

Nom de la marque

Classification

Classification du POINT d’identification retourné

Nom Type Description
code

string

Propriété code
names

ClassificationName[]

Tableau de noms

ClassificationName

Nom de la classification

Nom Type Description
name

string

Nom de la propriété
nameLocale

string

Propriété Name Locale

DataSources

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

Nom Type Description
geometry

Geometry

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

Entity

Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.

Nom Type Description
position

string

Entité de position

EntryPoint

Point d’entrée du POI retourné.

Nom Type Description
position

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
type

EntryPointType

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

EntryPointType

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

Nom Type Description
main

string

minor

string

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

GeographicEntityType

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

Nom Type Description
Country

string

nom du pays/de la région
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ésent uniquement si type == Geography.

Nom Type Description
id

string

Passez ce paramètre en tant que geometryId à l’API Get Recherche 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 utilisant des noms courts « lat » & « lon ».

Nom Type Description
lat

number

Latitude, propriété
lon

number

Longitude, propriété

MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.

Nom Type Description
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.

Nom Type Description
mode

string

Valeur utilisée dans la requête : none ou « nextSevenDays »
timeRanges

OperatingHoursTimeRange[]

Liste des intervalles de temps pour les 7 prochains jours

OperatingHoursTime

Représente une date et une heure

Nom 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 à l’heure locale d’un POINT d’identification ; les valeurs possibles sont de 0 à 23.
minute

integer

Les minutes sont à l’heure locale d’un POINT d’identification ; les valeurs possibles sont comprises entre 0 et 59.

OperatingHoursTimeRange

Intervalle de temps ouvert pour un jour

Nom Type Description
endTime

OperatingHoursTime

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

OperatingHoursTime

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

PointOfInterest

Détails des poI retournés, notamment des informations telles que le nom, le téléphone, l’adresse URL et les classifications.

Nom Type Description
brands

Brand[]

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

string[]

Tableau de catégories
categorySet

PointOfInterestCategorySet[]

Liste des catégories de POI les plus spécifiques
classifications

Classification[]

Tableau de classification
name

string

Nom de la propriété POI
openingHours

OperatingHours

Heures d’ouverture d’un point d’intérêt pour un point 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

Nom Type Description
id

integer

ID de la catégorie

QueryType

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

Nom Type Description
NEARBY

string

Recherche a été effectué autour d’une certaine latitude et longitude avec un rayon défini
NON_NEAR

string

Recherche a été effectué globalement, sans biaiser à une certaine latitude et longitude, et aucun rayon défini

Response

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

Nom Type Description
error

ErrorDetail

Objet error.
results

SearchAddressResultItem[]

Liste des résultats de l’API Recherche.
summary

SearchSummary

Objet Summary pour une réponse d’API Recherche

SearchAddressBatchItem

Élément retourné par Recherche’appel de service Address Batch.

Nom Type Description
response

Response

Résultat de la requête. SearchAddressResult si la requête s’est terminée correctement, Sinon, ErrorResponse.
statusCode

integer

Requête HTTP status code.

SearchAddressBatchProcessResult

Cet objet est retourné à partir d’un appel de service Recherche Address Batch réussi.

Nom Type Description
batchItems

SearchAddressBatchItem[]

Tableau contenant les résultats du lot.
summary

Summary

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

SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.

Nom Type Description
address

Address

Adresse du résultat
addressRanges

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.
dataSources

DataSources

Section facultative. Référencer l’ID de géométrie à utiliser avec l’API Obtenir Recherche Polygon.
detourTime

integer

Temps de détour en secondes. Retourné uniquement pour les appels à l’API Recherche Along Route.
dist

number

Distance de ligne droite entre le résultat et l’emplacement géographique en mètres.
entityType

GeographicEntityType

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

EntryPoint[]

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

string

Propriété Id
info

string

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

MatchType

Informations sur le type de correspondance.

Valeurs possibles :

  • AddressPoint
  • HouseNumberRange
  • Rue
poi

PointOfInterest

Détails des poI retournés, notamment des informations telles que le nom, le téléphone, l’adresse URL et les classifications.
position

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
score

number

Valeur dans un jeu de résultats pour indiquer le score de correspondance relative 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 de y. Les valeurs varient d’une requête à l’autre et sont uniquement destinées à une valeur relative pour un jeu de résultats.
type

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
viewport

BoundingBox

Fenêtre d’affichage qui couvre le résultat représenté par les coordonnées en haut à gauche et en bas à droite de la fenêtre d’affichage.

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
Nom 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 Recherche.

Nom Type Description
fuzzyLevel

integer

Niveau de flou maximal requis pour fournir des résultats.
geoBias

LatLongPairAbbreviated

Indication quand 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 lorsqu’ils sont disponibles. Dans d’autres cas, c’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 du résultat retourné 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

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

Nom Type Description
successfulRequests

integer

Nombre de demandes réussies dans le lot
totalRequests

integer

Nombre total de demandes dans le lot