Search - Post Search Inside Geometry

Référence

Service:: Maps

API Version:: 1.0

Utilisez pour effectuer des recherches au format libre à l’intérieur d’une géométrie supplémentaire.

L’API Post Search Inside Geometry est et HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned. To send the geometry you will use a POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** Thegeometrycan be represented as aGeoJSON FeatureCollectioncan contain a max of 50object. This is the recommended option if the geometry contains both Polygons and Circles. TheGeoJSON Featureobject for the Circle geometry is composed of a _center_ represented using aobjects. Eachobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>Aobject for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>AGeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul> Please see the Examples section below for a sampleFeatureCollectionrepresentation. </li><li>**GeoJSON GeometryCollection** Thegeometrycan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeoJSON Polygon GeometryCollection GeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. EachGeometryCollectionobject can have a max of 50 coordinates. Please see the Examples section below for a samplerepresentation. </li><li>**GeoJSON Polygon** Thegeometrycan be represented as aGeoJSON Polygonobject. This is the recommended option if the geometry contains a single Polygon. ThePolygon Polygone GeoJSON Polygon Polygoneobject can have a max of 50 coordinates. Please see the Examples section below for a sampleReprésentation polygonale.

.

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

With optional parameters:

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
query	query	True	string	Nom poI à rechercher (par exemple, « statue de la liberté », « starbucks », « pizza »). L’URL doit être correctement encodée.
categorySet	query		integer[]	Liste séparée par des virgules d’ID d’ensemble de catégories qui peut être utilisée pour limiter le résultat à des catégories de points d’intérêt spécifiques. L’ordre des ID n’a pas d’importance. Le nombre maximal de `categorySet` valeurs prises en charge par demande est de 10. Lorsque plusieurs identificateurs de catégorie sont fournis, seuls les points d’accès qui appartiennent à (au moins) une des catégories de la liste fournie sont retournés. La liste des catégories prises en charge peut être découverte à l’aide de l’API Catégories poI . Exemples d'utilisation : categorySet=7315 (Recherche points d’intérêt de la catégorie Restaurant) categorySet=7315025,7315017 (Recherche points d’intérêt de la catégorie Restaurant italien ou Français)
extendedPostalCodesFor	query		SearchIndexes[]	Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : Addr = Plages d’adresses Géo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues croisées (intersections) La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index. Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement si nécessaire. Exemples d'utilisation : extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.
idxSet	query		SearchIndexes[]	Liste d’index séparés par des virgules qui doivent être utilisés pour la recherche. L’ordre des éléments importe peu. Les index disponibles sont : Addr = Interpolation de plage d’adresses, Geo = Zones géographiques, PAD = Adresses de point, POI = Points d’intérêt, Str = Rues, Xstr = Rues croisées (intersections)
language	query		string	Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, ne respectant pas la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez Langues prises en charge .
limit	query		integer	Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100
openingHours	query		OperatingHoursRange	Heures d’ouverture d’un point d’intérêt (points d’intérêt). La disponibilité des heures de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera retournée. Valeur prise en charge : nextSevenDays
view	query		LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte 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.

Corps de la demande

Nom	Type	Description
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Objet `GeoJSON` valide. Pour plus d’informations, consultez RFC 7946 .

Réponses

Nom	Type	Description
200 OK	SearchAddressResult	Ok
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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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
In: 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
In: header

Exemples

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

HTTP

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

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

HTTP

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

HTTP

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

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.
GeoJsonFeature	Type d’objet valide `GeoJSON Feature` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonFeatureCollection	Type d’objet valide `GeoJSON FeatureCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometry	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
GeoJsonGeometryCollection	Type d’objet valide `GeoJSON GeometryCollection` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonLineString	Type de géométrie valide `GeoJSON LineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiLineString	Type de géométrie valide `GeoJSON MultiLineString` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPoint	Type de géométrie valide `GeoJSON MultiPoint` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonMultiPolygon	Type d’objet valide `GeoJSON MultiPolygon` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPoint	Type de géométrie valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
GeoJsonPolygon	Type de géométrie valide `GeoJSON Polygon` . Pour plus d’informations, consultez RFC 7946 .
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 ».
LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.
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.
OperatingHoursRange	Heures d’ouverture d’un point d’intérêt (points d’intérêt). La disponibilité des heures de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera retournée. Valeur prise en charge : nextSevenDays
OperatingHoursTime	Représente une date et une heure
OperatingHoursTimeRange	Intervalle de temps ouvert pour un jour
PointOfInterest	Détails du POINT d’identification retourné, y compris 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.
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
SearchAddressResult	Cet objet est retourné à partir d’un Recherche appels réussis.
SearchAddressResultItem	Objet Result pour une réponse d’API Recherche.
SearchAddressResultType	Valeurs possibles : POI Rue Geography Adresse exacte Plage d’adresses Croisement
SearchIndexes	Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : Addr = Plages d’adresses Géo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues croisées (intersections) La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index. Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement si nécessaire. Exemples d'utilisation : extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.
SearchInsideGeometryRequest	Ce type représente le corps de la demande pour le service Recherche Inside Geometry.
SearchSummary	Objet Summary pour une réponse d’API Recherche.

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

GeoJsonFeature

Type d’objet valide GeoJSON Feature . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
featureType	string	Type de la fonctionnalité. La valeur dépend du modèle de données dont fait partie la fonctionnalité actuelle. Certains modèles de données peuvent avoir une valeur vide.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objet geometry valide `GeoJSON` . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
id	string	Identificateur de la fonctionnalité.
type	string: Feature	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonFeatureCollection

Type d’objet valide GeoJSON FeatureCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
features	GeoJsonFeature[]	Contient une liste d’objets valides `GeoJSON Feature` .
type	string: FeatureCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometry

Objet geometry valide GeoJSON . Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
type	GeoJsonObjectType	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonGeometryCollection

Type d’objet valide GeoJSON GeometryCollection . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contient une liste d’objets geometry valides `GeoJSON` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: GeometryCollection	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonLineString

Type de géométrie valide GeoJSON LineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson LineString` géométrie.
type	string: LineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiLineString

Type de géométrie valide GeoJSON MultiLineString . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiLineString` géométrie.
type	string: MultiLineString	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPoint

Type de géométrie valide GeoJSON MultiPoint . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées de la `GeoJson MultiPoint` géométrie.
type	string: MultiPoint	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonMultiPolygon

Type d’objet valide GeoJSON MultiPolygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Contient une liste d’objets valides `GeoJSON Polygon` . Notez que les coordonnées dans GeoJSON sont dans l’ordre x, y (longitude, latitude).
type	string: MultiPolygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Un `Position` est un tableau de nombres avec au moins deux éléments. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Altitude est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPolygon

Type de géométrie valide GeoJSON Polygon . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
coordinates	number[]	Coordonnées du `GeoJson Polygon` type geometry.
type	string: Polygon	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

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	Propriété Latitude
lon	number	Longitude, propriété

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN.

Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.

Nom	Type	Description
AE	string	Émirats Arabes Unis (affichage arabe)
AR	string	Argentine (affichage argentin)
Auto	string	Retourne les données cartographiques correspondant à l’adresse IP de la requête.
BH	string	Bahreïn (affichage arabe)
IN	string	Inde (affichage indien)
IQ	string	Irak (affichage arabe)
JO	string	Jordanie (affichage arabe)
KW	string	Koweït (affichage arabe)
LB	string	Liban (affichage arabe)
MA	string	Maroc (affichage marocain)
OM	string	Oman (affichage arabe)
PK	string	Pakistan (affichage pakistanais)
PS	string	Autorité palestinienne (affichage arabe)
QA	string	Qatar (affichage arabe)
SA	string	Arabie Saoudite (affichage arabe)
SY	string	Syrie (affichage arabe)
Unified	string	Affichage unifié (Autres)
YE	string	Yémen (affichage arabe)

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

OperatingHoursRange

Heures d’ouverture d’un point d’intérêt (points d’intérêt). La disponibilité des heures de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera retournée. Valeur prise en charge : nextSevenDays

Nom	Type	Description
nextSevenDays	string	Affiche les heures d’ouverture de la semaine suivante, en commençant par le jour actuel à l’heure locale du point d’identification.

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 du POINT d’identification retourné, y compris 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

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript
xml	string	Langage de balisage extensible

SearchAddressResult

Cet objet est retourné à partir d’un Recherche appels réussis.

Nom	Type	Description
results	SearchAddressResultItem[]	Liste des résultats de l’API Recherche.
summary	SearchSummary	Objet Summary pour une réponse d’API Recherche

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. Id de géométrie de référence à utiliser avec l’API Get Recherche Polygon.
detourTime	integer	Temps de détour en secondes. Retourné uniquement pour les appels à l’API Recherche Along Route.
dist	number	Distance en 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 d’entrée, et « mineur », 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 du POINT d’identification retourné, y compris 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	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.

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

SearchIndexes

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.

Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement si nécessaire.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

Nom	Type	Description
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchInsideGeometryRequest

Ce type représente le corps de la demande pour le service Recherche Inside Geometry.

Nom	Type	Description
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Objet `GeoJSON` valide. Pour plus d’informations, consultez RFC 7946 .

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.

Search - Post Search Inside Geometry

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Scopes

subscription-key

SAS Token

Exemples

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

Sample Response

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

Sample Response

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

Sample Response

Définitions

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursRange

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchInsideGeometryRequest

SearchSummary

Ressources supplémentaires