{ "swagger": "2.0", "info": { "title": "Maps Search", "version": "2026-01-01", "description": "Azure Maps Search REST APIs", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "name": "endpoint", "in": "path", "description": "The Azure Maps service hostname. Use `https://atlas.microsoft.com` for the Azure public cloud. To target a specific Azure Maps geography or a sovereign cloud, see [Azure Maps geographic scope](https://learn.microsoft.com/azure/azure-maps/geographic-scope).", "required": true, "type": "string", "format": "uri", "default": "https://atlas.microsoft.com", "x-ms-skip-url-encoding": true } ] }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "AadToken": [ "https://atlas.microsoft.com/.default" ] }, { "AzureKey": [] }, { "SasToken": [] } ], "securityDefinitions": { "AadToken": { "type": "oauth2", "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n>\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations.\n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "https://atlas.microsoft.com/.default": "" } }, "AzureKey": { "type": "apiKey", "description": "This is a shared key that is provisioned when you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\nWith this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\nFor publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.", "name": "subscription-key", "in": "header" }, "SasToken": { "type": "apiKey", "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\nWith this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\nFor publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", "name": "SAS Token", "in": "header" } }, "tags": [], "paths": { "/geocode": { "get": { "operationId": "Search_GetGeocoding", "summary": "Use to get longitude and latitude coordinates of a street address or name of a place.", "description": "The `Get Geocoding` API is an HTTP `GET` request that returns the longitude and latitude coordinates of the location being searched.\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocoding endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No Point of Interest (POIs) will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties and states. The response also returns detailed address properties such as street, postal code, municipality, and country/region information.", "produces": [ "application/geo+json", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "top", "in": "query", "description": "Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20.", "required": false, "type": "integer", "format": "int32", "default": 5, "minimum": 1, "maximum": 20 }, { "name": "query", "in": "query", "description": "A string that contains information about a location, such as an address or landmark name.", "required": false, "type": "string" }, { "name": "addressLine", "in": "query", "description": "The official street line of an address relative to the area, as specified by the locality, or postalCode, properties. Typical use of this element would be to provide a street address or any official address.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "countryRegion", "in": "query", "description": "Signal for the geocoding result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "bbox", "in": "query", "description": "A rectangular area on the earth defined as a bounding box object. The sides of the rectangle are defined by longitude and latitude values. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.\n\nExample: lon1,lat1,lon2,lat2.\n\nMinimum size approximately 0.00001 degrees (~1.1 meters)\n\nMaximum size: up to the full global extent (-180,-90 to 180,90)", "required": false, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 4, "maxItems": 4 }, { "name": "view", "in": "query", "description": "A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to \"Auto\" even if you haven't defined it in the request.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", "required": false, "type": "string" }, { "name": "coordinates", "in": "query", "description": "A point on the earth specified as a longitude and latitude. When you specify this parameter, the user's location is taken into account and the results returned may be more relevant to the user. Example: &coordinates=lon,lat", "required": false, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 2, "maxItems": 2 }, { "name": "adminDistrict", "in": "query", "description": "The country subdivision portion of an address, such as WA.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "adminDistrict2", "in": "query", "description": "The county for the structured address, such as King.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "adminDistrict3", "in": "query", "description": "The named area for the structured address.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "locality", "in": "query", "description": "The locality portion of an address, such as Seattle.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "postalCode", "in": "query", "description": "The postal code portion of an address.\n\nThis parameter should not be used when the `query` parameter is included in the request.", "required": false, "type": "string" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GeocodingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Search detail address 15127 NE 24th Street, Redmond, WA": { "$ref": "./examples/ForwardGeocoding.json" }, "Search detail address 15127 NE 24th Street, Redmond, WA by addressLine": { "$ref": "./examples/ForwardGeocodingByAddressLine.json" }, "Search detail address 15127 NE 24th Street, Redmond, WA by query": { "$ref": "./examples/ForwardGeocodingByQuery.json" }, "Search landmark Empire State Building by query": { "$ref": "./examples/ForwardGeocodingFindLandmarkByQuery.json" } } } }, "/geocode:autocomplete": { "get": { "operationId": "Search_GetGeocodeAutocomplete", "summary": "Use to get ranked list of suggested entities based on a user's location and a partial query.", "description": "Given a request with a user's location and a partial query that serves as the prefix of a full query string (referred to as a query prefix), the Azure Maps Autocomplete API returns a list of suggested entities that the user is most likely searching for. These entities are ranked from most to least likely.", "produces": [ "application/geo+json", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "query", "in": "query", "description": "Required. The user's query prefix.\n\nExample: \"1 Micro\" or \"Muir Woods\".", "required": true, "type": "string" }, { "name": "coordinates", "in": "query", "description": "Required when `bbox` is not provided. A point on the earth specified as a longitude and latitude. When you specify this parameter, the user's location is taken into account and the results returned may be more relevant to the user. Example: &coordinates=lon,lat\n\n**Note:** `coordinates` becomes a secondary signal if `bbox` is provided.", "required": false, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 2, "maxItems": 2 }, { "name": "bbox", "in": "query", "description": "Required when `coordinates` is not provided. A rectangular area on the earth defined as a bounding box object. The sides of the rectangle are defined by longitude and latitude values. When you specify this parameter, the geographical area is taken into account when computing the results of a location query.\n\nExample: lon1,lat1,lon2,lat2.\n\nMinimum size approximately 0.00001 degrees (~1.1 meters)\n\nMaximum size: up to the full global extent (-180,-90 to 180,90)", "required": false, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 4, "maxItems": 4 }, { "name": "top", "in": "query", "description": "Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20.", "required": false, "type": "integer", "format": "int32", "default": 5, "minimum": 1, "maximum": 20 }, { "name": "resultTypeGroups", "in": "query", "description": "A comma separated list of returned entity type groups. The possible values are\n\n- Address\n- Place", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Address", "Place" ], "x-ms-enum": { "name": "AutocompleteResultTypeGroupsEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "Suggestions that resolve to a specific address or a road segment." }, { "name": "Place", "value": "Place", "description": "Suggestions that resolve to named places, including administrative regions, populated\nplaces, neighborhoods, natural features, and points of interest. Examples include\n`AdminDivision1`, `Neighborhood`, and `PopulatedPlace`." } ] } }, "collectionFormat": "csv" }, { "name": "resultTypes", "in": "query", "description": "A comma separated list of returned entity types. When type group is set to Address, the supported types are:\n\n- Address\n- RoadBlock\n\nAll other types belong to the Place type group. These may include entities such as AdminDivision1, Neighborhood, PopulatedPlace, and more. Default value is all possible entity types.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Address", "AdminDivision1", "AdminDivision2", "AdminDivision3", "AdministrativeBuilding", "Airport", "AirportTerminal", "AmusementPark", "AncientSite", "Aquarium", "Archipelago", "Basin", "Battlefield", "Bay", "Beach", "Bridge", "BusinessStructure", "Camp", "Canal", "Casino", "Castle", "Cave", "Cemetery", "Channel", "Church", "Cliff", "Coast", "CommunityCenter", "Continent", "CountryRegion", "Crater", "CulturalRegion", "Dam", "Delta", "Desert", "DrainageBasin", "Dune", "FacilityStructure", "FerryTerminal", "FinancialStructure", "FireStation", "Forest", "Fort", "Garden", "Geyser", "Glacier", "GolfCourse", "GreaterPopulatedPlace", "HigherEducationFacility", "HistoricalSite", "Hospital", "HotSpring", "Ice", "IndigenousPeoplesReserve", "IndustrialStructure", "Island", "Isthmus", "Lake", "LandArea", "Landform", "LandmarkBuilding", "Library", "Lighthouse", "Marina", "Market", "MedicalStructure", "MetroStation", "MilitaryBase", "Mission", "Monument", "Mosque", "Mountain", "MountainRange", "MultiModalStation", "Museum", "NauticalStructure", "Neighborhood", "Oasis", "ObservationPoint", "Ocean", "OfficeBuilding", "Other", "Park", "ParkingStructure", "Pass", "Peninsula", "Plain", "Planet", "Plateau", "Playground", "PlayingField", "Pole", "PoliticalUnit", "PopulatedPlace", "Port", "Postcode1", "Promontory", "RaceTrack", "RailwayStation", "Reef", "ReligiousStructure", "Reserve", "ResidentialStructure", "River", "RoadBlock", "Ruin", "ScientificResearchBase", "Sea", "SeaplaneLandingArea", "Shrine", "SkiArea", "Spring", "Stadium", "StatisticalDistrict", "Temple", "Theater", "TouristRailway", "TouristStructure", "Trailhead", "TransportationStructure", "Tunnel", "Valley", "Volcano", "Walkway", "Wall", "Waterfall", "WaterFeature", "Wetland", "Winery", "Zoo" ], "x-ms-enum": { "name": "AutocompleteResultTypeEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "A specific street address." }, { "name": "AdminDivision1", "value": "AdminDivision1", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "AdminDivision2", "value": "AdminDivision2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "AdminDivision3", "value": "AdminDivision3", "description": "Third administrative level within the country/region, such as a district, parish, or\nmunicipality. Retained for API compatibility. This type is not currently returned by the\nAutocomplete service; requests filtered exclusively to this type return an empty result\nset." }, { "name": "AdministrativeBuilding", "value": "AdministrativeBuilding", "description": "A building that houses government offices or public administrative functions." }, { "name": "Airport", "value": "Airport", "description": "A facility where aircraft regularly take off and land, with facilities for passengers\nand cargo." }, { "name": "AirportTerminal", "value": "AirportTerminal", "description": "A passenger terminal building within an airport. Availability varies by geography and\nmight change as Azure Maps search data is updated. Matching suggestions aren't\nguaranteed for every query." }, { "name": "AmusementPark", "value": "AmusementPark", "description": "An entertainment facility featuring rides, games, and themed attractions." }, { "name": "AncientSite", "value": "AncientSite", "description": "A place where archaeological remains or cultural artifacts of an ancient civilization are\npreserved." }, { "name": "Aquarium", "value": "Aquarium", "description": "A public facility where aquatic plants and animals are exhibited and studied." }, { "name": "Archipelago", "value": "Archipelago", "description": "A group or chain of islands." }, { "name": "Basin", "value": "Basin", "description": "A natural depression in the land surface, often surrounded by higher terrain." }, { "name": "Battlefield", "value": "Battlefield", "description": "A site of a historically significant land battle." }, { "name": "Bay", "value": "Bay", "description": "A body of water partially enclosed by land, smaller than a gulf and larger than a cove." }, { "name": "Beach", "value": "Beach", "description": "A shore of sand, pebble, or other unconsolidated sediment along a body of water." }, { "name": "Bridge", "value": "Bridge", "description": "A structure carrying a road, railway, or path across an obstacle such as a river,\nvalley, or another road." }, { "name": "BusinessStructure", "value": "BusinessStructure", "description": "A building used for general business or commercial activities that doesn't fit a more\nspecific category." }, { "name": "Camp", "value": "Camp", "description": "A site with shelters or facilities for temporary occupation, such as a campground or\nseasonal settlement." }, { "name": "Canal", "value": "Canal", "description": "An artificial watercourse used for transportation, irrigation, or drainage." }, { "name": "Casino", "value": "Casino", "description": "A facility used for gambling and games of chance." }, { "name": "Castle", "value": "Castle", "description": "A historically fortified building or complex of buildings, typically associated with noble\nor royal residence." }, { "name": "Cave", "value": "Cave", "description": "A natural underground chamber or passage formed in rock." }, { "name": "Cemetery", "value": "Cemetery", "description": "A burial place or graveyard." }, { "name": "Channel", "value": "Channel", "description": "A navigable waterway between two land bodies or the main flow path of a larger water\nbody." }, { "name": "Church", "value": "Church", "description": "A building used for public Christian worship." }, { "name": "Cliff", "value": "Cliff", "description": "A high, steep face of rock or earth, often overlooking a coast or valley." }, { "name": "Coast", "value": "Coast", "description": "A named stretch of land bordering the sea." }, { "name": "CommunityCenter", "value": "CommunityCenter", "description": "A facility hosting community activities, meetings, and social services." }, { "name": "Continent", "value": "Continent", "description": "One of the Earth's major landmasses." }, { "name": "CountryRegion", "value": "CountryRegion", "description": "A country or region." }, { "name": "Crater", "value": "Crater", "description": "A circular depression formed by volcanic activity or meteorite impact." }, { "name": "CulturalRegion", "value": "CulturalRegion", "description": "An area distinguished by shared cultural characteristics, such as language, ethnicity, or\nheritage." }, { "name": "Dam", "value": "Dam", "description": "A barrier constructed across a stream or river to impound water." }, { "name": "Delta", "value": "Delta", "description": "A landform of alluvial deposits formed where a river meets a larger body of water." }, { "name": "Desert", "value": "Desert", "description": "A large arid region with sparse vegetation due to limited precipitation." }, { "name": "DrainageBasin", "value": "DrainageBasin", "description": "An area of land drained by a river system and its tributaries." }, { "name": "Dune", "value": "Dune", "description": "A mound or ridge of wind-blown sand." }, { "name": "FacilityStructure", "value": "FacilityStructure", "description": "A structure that houses a specialized facility, such as a utility plant or service\ninstallation." }, { "name": "FerryTerminal", "value": "FerryTerminal", "description": "A facility where passengers and vehicles board and disembark ferries." }, { "name": "FinancialStructure", "value": "FinancialStructure", "description": "A building that houses a bank, credit union, or other financial services institution.\nAvailability varies by geography and might change as Azure Maps search data is updated.\nMatching suggestions aren't guaranteed for every query." }, { "name": "FireStation", "value": "FireStation", "description": "A building that houses firefighters, equipment, and emergency response vehicles." }, { "name": "Forest", "value": "Forest", "description": "A large area of land dominated by trees." }, { "name": "Fort", "value": "Fort", "description": "A defensive military structure or earthworks." }, { "name": "Garden", "value": "Garden", "description": "A cultivated area for displaying ornamental or scientifically curated plants." }, { "name": "Geyser", "value": "Geyser", "description": "A hot spring that periodically erupts jets of water and steam." }, { "name": "Glacier", "value": "Glacier", "description": "A persistent mass of ice that moves slowly under its own weight." }, { "name": "GolfCourse", "value": "GolfCourse", "description": "A field laid out for playing golf." }, { "name": "GreaterPopulatedPlace", "value": "GreaterPopulatedPlace", "description": "A metropolitan area or conurbation that contains and extends beyond a populated place.\nRetained for API compatibility. This type is not currently returned by the Autocomplete\nservice; requests filtered exclusively to this type return an empty result set." }, { "name": "HigherEducationFacility", "value": "HigherEducationFacility", "description": "A college, university, or similar institution of post-secondary education." }, { "name": "HistoricalSite", "value": "HistoricalSite", "description": "A site of historical significance, often preserved as a cultural heritage location." }, { "name": "Hospital", "value": "Hospital", "description": "A medical facility providing inpatient and outpatient care." }, { "name": "HotSpring", "value": "HotSpring", "description": "A natural spring where geothermally heated groundwater emerges at the surface." }, { "name": "Ice", "value": "Ice", "description": "A natural mass or surface layer of frozen water covering land or water." }, { "name": "IndigenousPeoplesReserve", "value": "IndigenousPeoplesReserve", "description": "A territory recognized as the homeland of an indigenous people or community." }, { "name": "IndustrialStructure", "value": "IndustrialStructure", "description": "A building or installation used for manufacturing, production, or other industrial\noperations." }, { "name": "Island", "value": "Island", "description": "A landmass surrounded by water, smaller than a continent." }, { "name": "Isthmus", "value": "Isthmus", "description": "A narrow strip of land connecting two larger landmasses and separating two bodies of\nwater." }, { "name": "Lake", "value": "Lake", "description": "An inland body of standing water surrounded by land." }, { "name": "LandArea", "value": "LandArea", "description": "A named land region that doesn't fit a more specific geographic category." }, { "name": "Landform", "value": "Landform", "description": "A natural land feature that doesn't fit a more specific category, such as a `Mountain`,\n`Valley`, or `Plateau`." }, { "name": "LandmarkBuilding", "value": "LandmarkBuilding", "description": "A notable building of architectural, cultural, or historical significance that serves as\na recognizable landmark." }, { "name": "Library", "value": "Library", "description": "A building that houses a collection of books and other media available for public use." }, { "name": "Lighthouse", "value": "Lighthouse", "description": "A coastal or harbor structure displaying a navigation light to guide ships." }, { "name": "Marina", "value": "Marina", "description": "A harbor facility providing moorings and services for small boats and yachts." }, { "name": "Market", "value": "Market", "description": "A place where goods are bought and sold, typically at retail." }, { "name": "MedicalStructure", "value": "MedicalStructure", "description": "A building used for medical or health-related services other than a `Hospital`, such as\na clinic or medical office." }, { "name": "MetroStation", "value": "MetroStation", "description": "A station on a subway, underground, or other urban rapid-transit rail system." }, { "name": "MilitaryBase", "value": "MilitaryBase", "description": "An installation operated by armed forces for training, supply, or operations." }, { "name": "Mission", "value": "Mission", "description": "A complex operated by a religious group to provide community services and propagate faith." }, { "name": "Monument", "value": "Monument", "description": "A commemorative structure or statue erected to honor a person, event, or idea." }, { "name": "Mosque", "value": "Mosque", "description": "A building used for public Islamic worship." }, { "name": "Mountain", "value": "Mountain", "description": "A landform that rises significantly above its surroundings, typically with steep slopes\nand a defined summit." }, { "name": "MountainRange", "value": "MountainRange", "description": "A connected series of mountains forming a continuous range." }, { "name": "MultiModalStation", "value": "MultiModalStation", "description": "A station that serves multiple transportation modes, such as combined rail, bus, or\nmetro services." }, { "name": "Museum", "value": "Museum", "description": "A facility where objects of artistic, scientific, or historical interest are preserved\nand exhibited." }, { "name": "NauticalStructure", "value": "NauticalStructure", "description": "A structure related to maritime or nautical activity, such as a pier, dock, or buoy." }, { "name": "Neighborhood", "value": "Neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "Oasis", "value": "Oasis", "description": "A fertile area in a desert sustained by a natural water source." }, { "name": "ObservationPoint", "value": "ObservationPoint", "description": "A vantage point or lookout providing scenic views of the surrounding area." }, { "name": "Ocean", "value": "Ocean", "description": "One of the major divisions of Earth's global ocean." }, { "name": "OfficeBuilding", "value": "OfficeBuilding", "description": "A building used primarily for professional or administrative office space." }, { "name": "Other", "value": "Other", "description": "A suggestion that doesn't fit any other defined type." }, { "name": "Park", "value": "Park", "description": "An area maintained for public recreation or scenic enjoyment." }, { "name": "ParkingStructure", "value": "ParkingStructure", "description": "A multi-level structure dedicated to vehicle parking." }, { "name": "Pass", "value": "Pass", "description": "A navigable route through or over a mountain range or similar obstruction." }, { "name": "Peninsula", "value": "Peninsula", "description": "A landmass projecting into a body of water and nearly surrounded by it." }, { "name": "Plain", "value": "Plain", "description": "An extensive area of relatively flat or gently undulating land." }, { "name": "Planet", "value": "Planet", "description": "A celestial body orbiting a star, typically used to represent the Earth as the root of\nthe geographic hierarchy. Availability varies by geography and might change as Azure\nMaps search data is updated. Matching suggestions aren't guaranteed for every query." }, { "name": "Plateau", "value": "Plateau", "description": "An elevated area of relatively level land with steep slopes on one or more sides." }, { "name": "Playground", "value": "Playground", "description": "A recreational area equipped for children's play." }, { "name": "PlayingField", "value": "PlayingField", "description": "An open area used for playing organized sports." }, { "name": "Pole", "value": "Pole", "description": "A geographic pole, such as the North or South Pole. Availability varies by geography\nand might change as Azure Maps search data is updated. Matching suggestions aren't\nguaranteed for every query." }, { "name": "PoliticalUnit", "value": "PoliticalUnit", "description": "A self-governing political entity, such as an independent or dependent state or territory.\nRetained for API compatibility. This type is not currently returned by the Autocomplete\nservice; requests filtered exclusively to this type return an empty result set." }, { "name": "PopulatedPlace", "value": "PopulatedPlace", "description": "A concentrated area of human settlement, such as a city, town or village." }, { "name": "Port", "value": "Port", "description": "A maritime facility with terminals for loading and unloading waterborne cargo or\npassengers." }, { "name": "Postcode1", "value": "Postcode1", "description": "The smallest postal code category, such as a zip code." }, { "name": "Promontory", "value": "Promontory", "description": "A prominent elevated landform projecting into a lowland or body of water." }, { "name": "RaceTrack", "value": "RaceTrack", "description": "A track or course laid out for racing vehicles, animals, or athletes." }, { "name": "RailwayStation", "value": "RailwayStation", "description": "A facility where passengers board and disembark trains." }, { "name": "Reef", "value": "Reef", "description": "A submerged or partially submerged ridge of rock, sand, or coral near the water surface." }, { "name": "ReligiousStructure", "value": "ReligiousStructure", "description": "A building used for religious worship or practice that doesn't fit a more specific\ncategory, such as `Church`, `Mosque`, or `Temple`." }, { "name": "Reserve", "value": "Reserve", "description": "A protected tract of land set aside for conservation, wildlife, or other restricted use." }, { "name": "ResidentialStructure", "value": "ResidentialStructure", "description": "A building used primarily for human residence, such as an apartment or housing complex." }, { "name": "River", "value": "River", "description": "A natural watercourse flowing to a lower elevation, typically toward a sea, lake, or\nanother river." }, { "name": "RoadBlock", "value": "RoadBlock", "description": "A street segment without a specific house number, returned when the geocoding service\ncannot locate an exact house number for the query. Despite its name, this value does not\nindicate a physical road closure." }, { "name": "Ruin", "value": "Ruin", "description": "A destroyed or decayed structure that no longer serves its original function." }, { "name": "ScientificResearchBase", "value": "ScientificResearchBase", "description": "A facility used as a base for scientific research, often in remote or extreme\nenvironments." }, { "name": "Sea", "value": "Sea", "description": "A large body of salt water partially enclosed by land, smaller than an ocean." }, { "name": "SeaplaneLandingArea", "value": "SeaplaneLandingArea", "description": "An area of water designated for seaplanes to take off and land." }, { "name": "Shrine", "value": "Shrine", "description": "A structure or site that memorializes a person or commemorates a sacred event or concept." }, { "name": "SkiArea", "value": "SkiArea", "description": "A recreational area developed for skiing and other winter sports." }, { "name": "Spring", "value": "Spring", "description": "A natural source where groundwater flows from the earth's surface." }, { "name": "Stadium", "value": "Stadium", "description": "A large venue with tiered seating for spectator sports or events." }, { "name": "StatisticalDistrict", "value": "StatisticalDistrict", "description": "A region defined for statistical or census purposes, such as a metropolitan statistical\narea or census tract." }, { "name": "Temple", "value": "Temple", "description": "A building dedicated to religious worship." }, { "name": "Theater", "value": "Theater", "description": "A venue for presenting plays, films, or other live or recorded performances." }, { "name": "TouristRailway", "value": "TouristRailway", "description": "A scenic or heritage railway operated primarily for tourism rather than regular transit.\nAvailability varies by geography and might change as Azure Maps search data is updated.\nMatching suggestions aren't guaranteed for every query." }, { "name": "TouristStructure", "value": "TouristStructure", "description": "A building that serves tourists, such as a visitor center or tourist information office." }, { "name": "Trailhead", "value": "Trailhead", "description": "The starting point of a hiking, biking, or recreational trail." }, { "name": "TransportationStructure", "value": "TransportationStructure", "description": "A structure that supports transportation infrastructure, such as a toll plaza, weigh\nstation, or transit shelter." }, { "name": "Tunnel", "value": "Tunnel", "description": "An underground or underwater passage for road, rail, or pedestrian transit." }, { "name": "Valley", "value": "Valley", "description": "An elongated low-lying area between hills or mountains, often containing a watercourse." }, { "name": "Volcano", "value": "Volcano", "description": "A mountain or hill formed by volcanic activity, typically with a crater at its summit." }, { "name": "Walkway", "value": "Walkway", "description": "A path or paved surface designated for pedestrian use." }, { "name": "Wall", "value": "Wall", "description": "A constructed barrier forming a continuous vertical boundary, often used for defense,\nseparation, or commemoration. Availability varies by geography and might change as\nAzure Maps search data is updated. Matching suggestions aren't guaranteed for every\nquery." }, { "name": "Waterfall", "value": "Waterfall", "description": "A point where a stream or river drops vertically or steeply." }, { "name": "WaterFeature", "value": "WaterFeature", "description": "A body of water that doesn't fit a more specific category, such as a `Lake`, `River`,\nor `Sea`." }, { "name": "Wetland", "value": "Wetland", "description": "An area of land saturated with water and supporting aquatic vegetation, such as a marsh\nor swamp." }, { "name": "Winery", "value": "Winery", "description": "A facility where wine is produced and often offered for tasting or sale." }, { "name": "Zoo", "value": "Zoo", "description": "A facility where wild animals are kept for public exhibition and study." } ] } }, "collectionFormat": "csv" }, { "name": "view", "in": "query", "description": "A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to \"Auto\" even if you haven't defined it in the request.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", "required": false, "type": "string" }, { "name": "countryRegion", "in": "query", "description": "Signal for the autocomplete result to an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that is specified e.g. FR. Only results in the specified country/region will be returned.", "required": false, "type": "string", "default": "none" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AutocompleteResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result": { "$ref": "./examples/AutocompleteNullResult.json" }, "Autocomplete API call to search for '1 Microsoft'": { "$ref": "./examples/AutocompleteDefault.json" }, "Autocomplete API call to search for '15010 NE 36th St WA'": { "$ref": "./examples/AutocompleteAddress.json" }, "Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups": { "$ref": "./examples/AutocompleteParkAndPopulatedPlaceResultType.json" }, "Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes": { "$ref": "./examples/AutocompleteParkResultType.json" }, "Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups": { "$ref": "./examples/AutocompletePlace.json" }, "Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups": { "$ref": "./examples/AutocompleteRoadBlockAddressResultType.json" } } } }, "/geocode:batch": { "post": { "operationId": "Search_GetGeocodingBatch", "summary": "Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.", "description": "The `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version={api-version}\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n- [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n- `Error` - If the query failed. The response will contain a `code` and a `message` in this case.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "geocodingBatchRequestBody", "in": "body", "description": "The list of address geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", "required": true, "schema": { "$ref": "#/definitions/GeocodingBatchRequestBody" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GeocodingBatchResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "A Geocoding Batch API call containing 2 Geocoding queries": { "$ref": "./examples/ForwardGeocodingBatch.json" } } } }, "/reverseGeocode": { "get": { "operationId": "Search_GetReverseGeocoding", "summary": "Use to get a street address and location info from longitude and latitude coordinates.", "description": "The `Get Reverse Geocoding` API is an HTTP `GET` request used to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Useful in tracking applications where you receive a GPS feed from the device or asset and wish to know the address associated with the coordinates. This endpoint will return address information for a given coordinate.", "produces": [ "application/geo+json", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "coordinates", "in": "query", "description": "The coordinates of the location that you want to reverse geocode. Example: &coordinates=lon,lat", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 2, "maxItems": 2 }, { "name": "resultTypes", "in": "query", "description": "Specify entity types that you want in the response. Only the types you specify will be returned. If the point cannot be mapped to the entity types you specify, no location information is returned in the response. Default value is all possible entities. A comma separated list of entity types selected from the following options.\n\n- Address\n- Neighborhood\n- PopulatedPlace\n- Postcode1\n- AdminDivision1\n- AdminDivision2\n- CountryRegion\n\nThese entity types are ordered from the most specific entity to the least specific entity. When entities of more than one entity type are found, only the most specific entity is returned. For example, if you specify Address and AdminDistrict1 as entity types and entities were found for both types, only the Address entity information is returned in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Address", "Neighborhood", "PopulatedPlace", "Postcode1", "AdminDivision1", "AdminDivision2", "CountryRegion" ], "x-ms-enum": { "name": "ReverseGeocodingResultTypeEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "A specific street address." }, { "name": "Neighborhood", "value": "Neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "PopulatedPlace", "value": "PopulatedPlace", "description": "A concentrated area of human settlement, such as a city, town or village." }, { "name": "Postcode1", "value": "Postcode1", "description": "The smallest postal code category, such as a zip code." }, { "name": "AdminDivision1", "value": "AdminDivision1", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "AdminDivision2", "value": "AdminDivision2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "CountryRegion", "value": "CountryRegion", "description": "A country or region." } ] } }, "collectionFormat": "csv" }, { "name": "view", "in": "query", "description": "A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to \"Auto\" even if you haven't defined it in the request.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GeocodingResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Search point -122.138681, 47.630358": { "$ref": "./examples/ReverseGeocoding.json" } } } }, "/reverseGeocode:batch": { "post": { "operationId": "Search_GetReverseGeocodingBatch", "summary": "Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.", "description": "The `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version={api-version}\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n- [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n- `Error` - If the query failed. The response will contain a `code` and a `message` in this case.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "reverseGeocodingBatchRequestBody", "in": "body", "description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.", "required": true, "schema": { "$ref": "#/definitions/ReverseGeocodingBatchRequestBody" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GeocodingBatchResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries": { "$ref": "./examples/ReverseGeocodingBatch.json" } } } }, "/search/polygon": { "get": { "operationId": "Search_GetPolygon", "summary": "Use to get polygon data of a geographical area shape such as a city or a country region.", "description": "The `Get Polygon` API is an HTTP `GET` request that supplies polygon data of a geographical area outline such as a city or a country region.", "produces": [ "application/geo+json", "application/json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "x-ms-client-id", "in": "header", "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication).", "required": false, "type": "string", "x-ms-client-name": "clientId" }, { "name": "Accept-Language", "in": "header", "description": "Language in which search results should be returned.\n\nPlease refer to [Supported Languages](/azure/azure-maps/supported-languages?pivots=service-latest) for details.", "required": false, "type": "string", "x-ms-client-name": "acceptLanguage" }, { "name": "coordinates", "in": "query", "description": "A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat", "required": true, "type": "array", "items": { "type": "number", "format": "double" }, "collectionFormat": "csv", "minItems": 2, "maxItems": 2 }, { "name": "view", "in": "query", "description": "A string that represents an [ISO 3166-1 Alpha-2 region/country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to \"Auto\" even if you haven't defined it in the request.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", "required": false, "type": "string" }, { "name": "resultType", "in": "query", "description": "The geopolitical concept to return a boundary for. If not specified, the default is `countryRegion` result type.", "required": false, "type": "string", "default": "countryRegion", "enum": [ "countryRegion", "adminDistrict", "adminDistrict2", "postalCode", "postalCode2", "postalCode3", "postalCode4", "neighborhood", "locality" ], "x-ms-enum": { "name": "BoundaryResultTypeEnum", "modelAsString": true, "values": [ { "name": "countryRegion", "value": "countryRegion", "description": "A country or region." }, { "name": "adminDistrict", "value": "adminDistrict", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "adminDistrict2", "value": "adminDistrict2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "postalCode", "value": "postalCode", "description": "The smallest postal code category, such as a zip code." }, { "name": "postalCode2", "value": "postalCode2", "description": "The next largest postal code category after `postalCode` that is created by aggregating\n`postalCode` areas." }, { "name": "postalCode3", "value": "postalCode3", "description": "The next largest postal code category after `postalCode2` that is created by aggregating\n`postalCode2` areas." }, { "name": "postalCode4", "value": "postalCode4", "description": "The next largest postal code category after `postalCode3` that is created by aggregating\n`postalCode3` areas." }, { "name": "neighborhood", "value": "neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "locality", "value": "locality", "description": "A concentrated area of human settlement, such as a city, town or village." } ] } }, { "name": "resolution", "in": "query", "description": "Resolution determines the amount of points to send back. If not specified, the default is medium resolution.", "required": false, "type": "string", "default": "medium", "enum": [ "small", "medium", "large", "huge" ], "x-ms-enum": { "name": "ResolutionEnum", "modelAsString": true, "values": [ { "name": "small", "value": "small", "description": "Returns the boundary geometry with the fewest points." }, { "name": "medium", "value": "medium", "description": "Returns the boundary geometry with the same number of points as `small` or more." }, { "name": "large", "value": "large", "description": "Returns the boundary geometry with the same number of points as `medium` or more." }, { "name": "huge", "value": "huge", "description": "Returns the boundary geometry with the same number of points as `large` or more." } ] } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Boundary" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Get polygon for a city at coordinates -122.204141,47.612560": { "$ref": "./examples/GetPolygon.json" } } } } }, "definitions": { "Address": { "type": "object", "description": "The address of a geocoded or autocomplete-suggested location, parsed into structured fields.\nSparseness is normal: only the fields that the resolved entity supplies are populated. For\nexample, `streetName` and `streetNumber` appear only for street-level addresses, and\n`intersection` appears only for road-intersection results.", "properties": { "addressLine": { "type": "string", "description": "The first line of the address, typically the street name and number. For example,\n`\"15127 NE 24th St\"`." }, "locality": { "type": "string", "description": "The locality the address falls within: usually a city, town, or village. For example:\n`\"Redmond\"`." }, "neighborhood": { "type": "string", "description": "The named neighborhood within the locality, when one is identified." }, "adminDistricts": { "type": "array", "description": "The administrative subdivisions that contain the address, ordered from coarsest to finest.\nThe first entry is typically the first-order subdivision (such as a U.S. state or a\nCanadian province); subsequent entries cover finer divisions where the country, dependency,\nor region defines them (such as a county at index 1).", "items": { "$ref": "#/definitions/AddressAdminDistrictsItem" } }, "postalCode": { "type": "string", "description": "The postal code for the address, when one is defined. Example: `\"98052\"`." }, "countryRegion": { "$ref": "#/definitions/AddressCountryRegion", "description": "The country or region that contains the address, with its display name and ISO 3166-1\nAlpha-2 country code." }, "formattedAddress": { "type": "string", "description": "The full address rendered as a single human-readable string, with the components joined\naccording to the conventions of the address's country or region. Example:\n`\"15127 NE 24th St, Redmond, WA 98052\"`." }, "streetName": { "type": "string", "description": "The street name component of the address, when the resolved entity is a street-level\naddress. Example: `\"NE 24th St\"`." }, "streetNumber": { "type": "string", "description": "The house or building number on the street, when the resolved entity is a street-level\naddress. Example: `\"15127\"`." }, "intersection": { "$ref": "#/definitions/Intersection", "description": "The intersecting-street details for the address, populated when the resolved entity is a\n`RoadIntersection` (such as the corner of two named streets)." } } }, "AddressAdminDistrictsItem": { "type": "object", "description": "An administrative subdivision that contains an address. For example, a state, province, or\ncounty. Returned as one entry in the parent `Address.adminDistricts` array, where entries are\nordered from coarsest to finest.", "properties": { "name": { "type": "string", "description": "The full name of the subdivision. For example, `\"Washington\"` for a U.S. state, or\n`\"King County\"` for a county." }, "shortName": { "type": "string", "description": "The short or abbreviated form of the subdivision name, when one is defined. For example,\n`\"WA\"` for a U.S. state. Finer subdivisions often have no distinct short form, in which case\n`shortName` repeats `name` (such as `\"King County\"`)." } } }, "AddressCountryRegion": { "type": "object", "description": "The country or region that contains the address, identified by its display name and ISO 3166-1\nAlpha-2 country code. Either field may be omitted in a given response.", "properties": { "ISO": { "type": "string", "description": "The ISO 3166-1 Alpha-2 country code for the country or region. For example, `\"US\"` for the\nUnited States, or `\"GB\"` for the United Kingdom." }, "name": { "type": "string", "description": "The display name of the country or region. For example, `\"United States\"`." } } }, "AutocompleteFeature": { "type": "object", "description": "A single entry in the `features` array of an `AutocompleteResponse`, conforming to the\n[`GeoJSON Feature`](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) object shape.\nRepresents one autocomplete suggestion: classification (`type`, `typeGroup`), parsed\naddress, and optional place name are exposed via `properties`, with a representative\ncoordinate on `geometry` when one is available.", "properties": { "type": { "$ref": "#/definitions/FeatureTypeEnum", "description": "The `GeoJSON` object type. Always `Feature`, as defined in\n[RFC 7946](https://www.rfc-editor.org/rfc/rfc7946)." }, "geometry": { "$ref": "#/definitions/GeoJsonPoint", "description": "The coordinate of the autocomplete suggestion as a\n[`GeoJSON Point`](https://tools.ietf.org/html/rfc7946#section-3.1.2), with values in WGS 84\nlongitude/latitude order. May be omitted when the suggestion does not resolve to a single\nrepresentative coordinate, for example, broad regional or place-name suggestions." }, "properties": { "$ref": "#/definitions/AutocompleteProperties", "description": "Structured data about the autocomplete suggestion, including its classification, parsed\naddress, and (for `Place`-typed suggestions) the place name. See `AutocompleteProperties`\nfor the per-property shape." } }, "required": [ "type", "properties" ] }, "AutocompleteProperties": { "type": "object", "description": "The `properties` payload of an `AutocompleteFeature`. Carries the result's classification\n(`typeGroup`, `type`), its parsed address, and (for many `Place`-typed results) a separate\ndisplay name.", "properties": { "typeGroup": { "$ref": "#/definitions/AutocompleteResultTypeGroupsEnum", "description": "The broad classification of the result as either an address or a named place. See\n`AutocompleteResultTypeGroupsEnum` for the value list." }, "type": { "$ref": "#/definitions/AutocompleteResultTypeEnum", "description": "The specific entity kind that the result resolves to. For example, an address, a populated\nplace, a park, or a landmark. See `AutocompleteResultTypeEnum` for the full value list,\npartitioned into the `Address` and `Place` groups by `AutocompleteResultTypeGroupsEnum`." }, "address": { "$ref": "#/definitions/Address", "description": "The address of the autocomplete result, parsed into structured fields. `Address`-typed\nresults typically include street-level detail; `Place`-typed results carry locality,\nadministrative districts, and country/region (street-level fields are usually omitted)." }, "name": { "type": "string", "description": "The display name of the suggested place. Populated for `Place`-typed results when the name\nis not already represented in the structured `address` (for example, parks, landmarks, or\nother named features). Omitted for `Address`-typed results and for `Place`-typed results\nwhose name is already included in `address` (such as a populated place whose name appears in\n`address.locality`)." } } }, "AutocompleteResponse": { "type": "object", "description": "The successful response body returned by `Get Autocomplete`. Encoded as a\n[`GeoJSON FeatureCollection`](https://www.rfc-editor.org/rfc/rfc7946) whose `features`\narray contains one `Feature` per autocomplete suggestion, ranked from most to least\nlikely.", "properties": { "type": { "$ref": "#/definitions/FeatureCollectionEnum", "description": "The `GeoJSON` object type of a successful `Get Autocomplete` response body. Always\n`FeatureCollection`, as defined in [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946)." }, "features": { "type": "array", "description": "The array of `GeoJSON Feature` objects returned by the query. Each `Feature` represents a\nsingle autocomplete suggestion: its classification (`type`, `typeGroup`), parsed address,\nand optional place name are exposed via `properties`, and its primary coordinate via\n`geometry`.", "items": { "$ref": "#/definitions/AutocompleteFeature" } }, "nextLink": { "type": "string", "description": "Contains the URL to fetch the next page of results if the response is paginated. This is\nuseful when the response is too large to be returned in a single call, allowing users to\nnavigate through multiple pages of results." } } }, "AutocompleteResultTypeEnum": { "type": "string", "description": "A classification of autocomplete suggestions used by `Get Autocomplete` both as an input\nfilter (via the `resultTypes` query parameter) and as an output label (via the `type`\nfield on each `AutocompleteProperties`). The members define a gazetteer-style taxonomy\nspanning addresses, road segments, administrative regions, populated places, natural\nfeatures, and points of interest. This taxonomy is partitioned into two broader groups\nby `AutocompleteResultTypeGroupsEnum`: `Address`, which covers addresses and road\nsegments; and `Place`, which covers all other result types.", "enum": [ "Address", "AdminDivision1", "AdminDivision2", "AdminDivision3", "AdministrativeBuilding", "Airport", "AirportTerminal", "AmusementPark", "AncientSite", "Aquarium", "Archipelago", "Basin", "Battlefield", "Bay", "Beach", "Bridge", "BusinessStructure", "Camp", "Canal", "Casino", "Castle", "Cave", "Cemetery", "Channel", "Church", "Cliff", "Coast", "CommunityCenter", "Continent", "CountryRegion", "Crater", "CulturalRegion", "Dam", "Delta", "Desert", "DrainageBasin", "Dune", "FacilityStructure", "FerryTerminal", "FinancialStructure", "FireStation", "Forest", "Fort", "Garden", "Geyser", "Glacier", "GolfCourse", "GreaterPopulatedPlace", "HigherEducationFacility", "HistoricalSite", "Hospital", "HotSpring", "Ice", "IndigenousPeoplesReserve", "IndustrialStructure", "Island", "Isthmus", "Lake", "LandArea", "Landform", "LandmarkBuilding", "Library", "Lighthouse", "Marina", "Market", "MedicalStructure", "MetroStation", "MilitaryBase", "Mission", "Monument", "Mosque", "Mountain", "MountainRange", "MultiModalStation", "Museum", "NauticalStructure", "Neighborhood", "Oasis", "ObservationPoint", "Ocean", "OfficeBuilding", "Other", "Park", "ParkingStructure", "Pass", "Peninsula", "Plain", "Planet", "Plateau", "Playground", "PlayingField", "Pole", "PoliticalUnit", "PopulatedPlace", "Port", "Postcode1", "Promontory", "RaceTrack", "RailwayStation", "Reef", "ReligiousStructure", "Reserve", "ResidentialStructure", "River", "RoadBlock", "Ruin", "ScientificResearchBase", "Sea", "SeaplaneLandingArea", "Shrine", "SkiArea", "Spring", "Stadium", "StatisticalDistrict", "Temple", "Theater", "TouristRailway", "TouristStructure", "Trailhead", "TransportationStructure", "Tunnel", "Valley", "Volcano", "Walkway", "Wall", "Waterfall", "WaterFeature", "Wetland", "Winery", "Zoo" ], "x-ms-enum": { "name": "AutocompleteResultTypeEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "A specific street address." }, { "name": "AdminDivision1", "value": "AdminDivision1", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "AdminDivision2", "value": "AdminDivision2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "AdminDivision3", "value": "AdminDivision3", "description": "Third administrative level within the country/region, such as a district, parish, or\nmunicipality. Retained for API compatibility. This type is not currently returned by the\nAutocomplete service; requests filtered exclusively to this type return an empty result\nset." }, { "name": "AdministrativeBuilding", "value": "AdministrativeBuilding", "description": "A building that houses government offices or public administrative functions." }, { "name": "Airport", "value": "Airport", "description": "A facility where aircraft regularly take off and land, with facilities for passengers\nand cargo." }, { "name": "AirportTerminal", "value": "AirportTerminal", "description": "A passenger terminal building within an airport. Availability varies by geography and\nmight change as Azure Maps search data is updated. Matching suggestions aren't\nguaranteed for every query." }, { "name": "AmusementPark", "value": "AmusementPark", "description": "An entertainment facility featuring rides, games, and themed attractions." }, { "name": "AncientSite", "value": "AncientSite", "description": "A place where archaeological remains or cultural artifacts of an ancient civilization are\npreserved." }, { "name": "Aquarium", "value": "Aquarium", "description": "A public facility where aquatic plants and animals are exhibited and studied." }, { "name": "Archipelago", "value": "Archipelago", "description": "A group or chain of islands." }, { "name": "Basin", "value": "Basin", "description": "A natural depression in the land surface, often surrounded by higher terrain." }, { "name": "Battlefield", "value": "Battlefield", "description": "A site of a historically significant land battle." }, { "name": "Bay", "value": "Bay", "description": "A body of water partially enclosed by land, smaller than a gulf and larger than a cove." }, { "name": "Beach", "value": "Beach", "description": "A shore of sand, pebble, or other unconsolidated sediment along a body of water." }, { "name": "Bridge", "value": "Bridge", "description": "A structure carrying a road, railway, or path across an obstacle such as a river,\nvalley, or another road." }, { "name": "BusinessStructure", "value": "BusinessStructure", "description": "A building used for general business or commercial activities that doesn't fit a more\nspecific category." }, { "name": "Camp", "value": "Camp", "description": "A site with shelters or facilities for temporary occupation, such as a campground or\nseasonal settlement." }, { "name": "Canal", "value": "Canal", "description": "An artificial watercourse used for transportation, irrigation, or drainage." }, { "name": "Casino", "value": "Casino", "description": "A facility used for gambling and games of chance." }, { "name": "Castle", "value": "Castle", "description": "A historically fortified building or complex of buildings, typically associated with noble\nor royal residence." }, { "name": "Cave", "value": "Cave", "description": "A natural underground chamber or passage formed in rock." }, { "name": "Cemetery", "value": "Cemetery", "description": "A burial place or graveyard." }, { "name": "Channel", "value": "Channel", "description": "A navigable waterway between two land bodies or the main flow path of a larger water\nbody." }, { "name": "Church", "value": "Church", "description": "A building used for public Christian worship." }, { "name": "Cliff", "value": "Cliff", "description": "A high, steep face of rock or earth, often overlooking a coast or valley." }, { "name": "Coast", "value": "Coast", "description": "A named stretch of land bordering the sea." }, { "name": "CommunityCenter", "value": "CommunityCenter", "description": "A facility hosting community activities, meetings, and social services." }, { "name": "Continent", "value": "Continent", "description": "One of the Earth's major landmasses." }, { "name": "CountryRegion", "value": "CountryRegion", "description": "A country or region." }, { "name": "Crater", "value": "Crater", "description": "A circular depression formed by volcanic activity or meteorite impact." }, { "name": "CulturalRegion", "value": "CulturalRegion", "description": "An area distinguished by shared cultural characteristics, such as language, ethnicity, or\nheritage." }, { "name": "Dam", "value": "Dam", "description": "A barrier constructed across a stream or river to impound water." }, { "name": "Delta", "value": "Delta", "description": "A landform of alluvial deposits formed where a river meets a larger body of water." }, { "name": "Desert", "value": "Desert", "description": "A large arid region with sparse vegetation due to limited precipitation." }, { "name": "DrainageBasin", "value": "DrainageBasin", "description": "An area of land drained by a river system and its tributaries." }, { "name": "Dune", "value": "Dune", "description": "A mound or ridge of wind-blown sand." }, { "name": "FacilityStructure", "value": "FacilityStructure", "description": "A structure that houses a specialized facility, such as a utility plant or service\ninstallation." }, { "name": "FerryTerminal", "value": "FerryTerminal", "description": "A facility where passengers and vehicles board and disembark ferries." }, { "name": "FinancialStructure", "value": "FinancialStructure", "description": "A building that houses a bank, credit union, or other financial services institution.\nAvailability varies by geography and might change as Azure Maps search data is updated.\nMatching suggestions aren't guaranteed for every query." }, { "name": "FireStation", "value": "FireStation", "description": "A building that houses firefighters, equipment, and emergency response vehicles." }, { "name": "Forest", "value": "Forest", "description": "A large area of land dominated by trees." }, { "name": "Fort", "value": "Fort", "description": "A defensive military structure or earthworks." }, { "name": "Garden", "value": "Garden", "description": "A cultivated area for displaying ornamental or scientifically curated plants." }, { "name": "Geyser", "value": "Geyser", "description": "A hot spring that periodically erupts jets of water and steam." }, { "name": "Glacier", "value": "Glacier", "description": "A persistent mass of ice that moves slowly under its own weight." }, { "name": "GolfCourse", "value": "GolfCourse", "description": "A field laid out for playing golf." }, { "name": "GreaterPopulatedPlace", "value": "GreaterPopulatedPlace", "description": "A metropolitan area or conurbation that contains and extends beyond a populated place.\nRetained for API compatibility. This type is not currently returned by the Autocomplete\nservice; requests filtered exclusively to this type return an empty result set." }, { "name": "HigherEducationFacility", "value": "HigherEducationFacility", "description": "A college, university, or similar institution of post-secondary education." }, { "name": "HistoricalSite", "value": "HistoricalSite", "description": "A site of historical significance, often preserved as a cultural heritage location." }, { "name": "Hospital", "value": "Hospital", "description": "A medical facility providing inpatient and outpatient care." }, { "name": "HotSpring", "value": "HotSpring", "description": "A natural spring where geothermally heated groundwater emerges at the surface." }, { "name": "Ice", "value": "Ice", "description": "A natural mass or surface layer of frozen water covering land or water." }, { "name": "IndigenousPeoplesReserve", "value": "IndigenousPeoplesReserve", "description": "A territory recognized as the homeland of an indigenous people or community." }, { "name": "IndustrialStructure", "value": "IndustrialStructure", "description": "A building or installation used for manufacturing, production, or other industrial\noperations." }, { "name": "Island", "value": "Island", "description": "A landmass surrounded by water, smaller than a continent." }, { "name": "Isthmus", "value": "Isthmus", "description": "A narrow strip of land connecting two larger landmasses and separating two bodies of\nwater." }, { "name": "Lake", "value": "Lake", "description": "An inland body of standing water surrounded by land." }, { "name": "LandArea", "value": "LandArea", "description": "A named land region that doesn't fit a more specific geographic category." }, { "name": "Landform", "value": "Landform", "description": "A natural land feature that doesn't fit a more specific category, such as a `Mountain`,\n`Valley`, or `Plateau`." }, { "name": "LandmarkBuilding", "value": "LandmarkBuilding", "description": "A notable building of architectural, cultural, or historical significance that serves as\na recognizable landmark." }, { "name": "Library", "value": "Library", "description": "A building that houses a collection of books and other media available for public use." }, { "name": "Lighthouse", "value": "Lighthouse", "description": "A coastal or harbor structure displaying a navigation light to guide ships." }, { "name": "Marina", "value": "Marina", "description": "A harbor facility providing moorings and services for small boats and yachts." }, { "name": "Market", "value": "Market", "description": "A place where goods are bought and sold, typically at retail." }, { "name": "MedicalStructure", "value": "MedicalStructure", "description": "A building used for medical or health-related services other than a `Hospital`, such as\na clinic or medical office." }, { "name": "MetroStation", "value": "MetroStation", "description": "A station on a subway, underground, or other urban rapid-transit rail system." }, { "name": "MilitaryBase", "value": "MilitaryBase", "description": "An installation operated by armed forces for training, supply, or operations." }, { "name": "Mission", "value": "Mission", "description": "A complex operated by a religious group to provide community services and propagate faith." }, { "name": "Monument", "value": "Monument", "description": "A commemorative structure or statue erected to honor a person, event, or idea." }, { "name": "Mosque", "value": "Mosque", "description": "A building used for public Islamic worship." }, { "name": "Mountain", "value": "Mountain", "description": "A landform that rises significantly above its surroundings, typically with steep slopes\nand a defined summit." }, { "name": "MountainRange", "value": "MountainRange", "description": "A connected series of mountains forming a continuous range." }, { "name": "MultiModalStation", "value": "MultiModalStation", "description": "A station that serves multiple transportation modes, such as combined rail, bus, or\nmetro services." }, { "name": "Museum", "value": "Museum", "description": "A facility where objects of artistic, scientific, or historical interest are preserved\nand exhibited." }, { "name": "NauticalStructure", "value": "NauticalStructure", "description": "A structure related to maritime or nautical activity, such as a pier, dock, or buoy." }, { "name": "Neighborhood", "value": "Neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "Oasis", "value": "Oasis", "description": "A fertile area in a desert sustained by a natural water source." }, { "name": "ObservationPoint", "value": "ObservationPoint", "description": "A vantage point or lookout providing scenic views of the surrounding area." }, { "name": "Ocean", "value": "Ocean", "description": "One of the major divisions of Earth's global ocean." }, { "name": "OfficeBuilding", "value": "OfficeBuilding", "description": "A building used primarily for professional or administrative office space." }, { "name": "Other", "value": "Other", "description": "A suggestion that doesn't fit any other defined type." }, { "name": "Park", "value": "Park", "description": "An area maintained for public recreation or scenic enjoyment." }, { "name": "ParkingStructure", "value": "ParkingStructure", "description": "A multi-level structure dedicated to vehicle parking." }, { "name": "Pass", "value": "Pass", "description": "A navigable route through or over a mountain range or similar obstruction." }, { "name": "Peninsula", "value": "Peninsula", "description": "A landmass projecting into a body of water and nearly surrounded by it." }, { "name": "Plain", "value": "Plain", "description": "An extensive area of relatively flat or gently undulating land." }, { "name": "Planet", "value": "Planet", "description": "A celestial body orbiting a star, typically used to represent the Earth as the root of\nthe geographic hierarchy. Availability varies by geography and might change as Azure\nMaps search data is updated. Matching suggestions aren't guaranteed for every query." }, { "name": "Plateau", "value": "Plateau", "description": "An elevated area of relatively level land with steep slopes on one or more sides." }, { "name": "Playground", "value": "Playground", "description": "A recreational area equipped for children's play." }, { "name": "PlayingField", "value": "PlayingField", "description": "An open area used for playing organized sports." }, { "name": "Pole", "value": "Pole", "description": "A geographic pole, such as the North or South Pole. Availability varies by geography\nand might change as Azure Maps search data is updated. Matching suggestions aren't\nguaranteed for every query." }, { "name": "PoliticalUnit", "value": "PoliticalUnit", "description": "A self-governing political entity, such as an independent or dependent state or territory.\nRetained for API compatibility. This type is not currently returned by the Autocomplete\nservice; requests filtered exclusively to this type return an empty result set." }, { "name": "PopulatedPlace", "value": "PopulatedPlace", "description": "A concentrated area of human settlement, such as a city, town or village." }, { "name": "Port", "value": "Port", "description": "A maritime facility with terminals for loading and unloading waterborne cargo or\npassengers." }, { "name": "Postcode1", "value": "Postcode1", "description": "The smallest postal code category, such as a zip code." }, { "name": "Promontory", "value": "Promontory", "description": "A prominent elevated landform projecting into a lowland or body of water." }, { "name": "RaceTrack", "value": "RaceTrack", "description": "A track or course laid out for racing vehicles, animals, or athletes." }, { "name": "RailwayStation", "value": "RailwayStation", "description": "A facility where passengers board and disembark trains." }, { "name": "Reef", "value": "Reef", "description": "A submerged or partially submerged ridge of rock, sand, or coral near the water surface." }, { "name": "ReligiousStructure", "value": "ReligiousStructure", "description": "A building used for religious worship or practice that doesn't fit a more specific\ncategory, such as `Church`, `Mosque`, or `Temple`." }, { "name": "Reserve", "value": "Reserve", "description": "A protected tract of land set aside for conservation, wildlife, or other restricted use." }, { "name": "ResidentialStructure", "value": "ResidentialStructure", "description": "A building used primarily for human residence, such as an apartment or housing complex." }, { "name": "River", "value": "River", "description": "A natural watercourse flowing to a lower elevation, typically toward a sea, lake, or\nanother river." }, { "name": "RoadBlock", "value": "RoadBlock", "description": "A street segment without a specific house number, returned when the geocoding service\ncannot locate an exact house number for the query. Despite its name, this value does not\nindicate a physical road closure." }, { "name": "Ruin", "value": "Ruin", "description": "A destroyed or decayed structure that no longer serves its original function." }, { "name": "ScientificResearchBase", "value": "ScientificResearchBase", "description": "A facility used as a base for scientific research, often in remote or extreme\nenvironments." }, { "name": "Sea", "value": "Sea", "description": "A large body of salt water partially enclosed by land, smaller than an ocean." }, { "name": "SeaplaneLandingArea", "value": "SeaplaneLandingArea", "description": "An area of water designated for seaplanes to take off and land." }, { "name": "Shrine", "value": "Shrine", "description": "A structure or site that memorializes a person or commemorates a sacred event or concept." }, { "name": "SkiArea", "value": "SkiArea", "description": "A recreational area developed for skiing and other winter sports." }, { "name": "Spring", "value": "Spring", "description": "A natural source where groundwater flows from the earth's surface." }, { "name": "Stadium", "value": "Stadium", "description": "A large venue with tiered seating for spectator sports or events." }, { "name": "StatisticalDistrict", "value": "StatisticalDistrict", "description": "A region defined for statistical or census purposes, such as a metropolitan statistical\narea or census tract." }, { "name": "Temple", "value": "Temple", "description": "A building dedicated to religious worship." }, { "name": "Theater", "value": "Theater", "description": "A venue for presenting plays, films, or other live or recorded performances." }, { "name": "TouristRailway", "value": "TouristRailway", "description": "A scenic or heritage railway operated primarily for tourism rather than regular transit.\nAvailability varies by geography and might change as Azure Maps search data is updated.\nMatching suggestions aren't guaranteed for every query." }, { "name": "TouristStructure", "value": "TouristStructure", "description": "A building that serves tourists, such as a visitor center or tourist information office." }, { "name": "Trailhead", "value": "Trailhead", "description": "The starting point of a hiking, biking, or recreational trail." }, { "name": "TransportationStructure", "value": "TransportationStructure", "description": "A structure that supports transportation infrastructure, such as a toll plaza, weigh\nstation, or transit shelter." }, { "name": "Tunnel", "value": "Tunnel", "description": "An underground or underwater passage for road, rail, or pedestrian transit." }, { "name": "Valley", "value": "Valley", "description": "An elongated low-lying area between hills or mountains, often containing a watercourse." }, { "name": "Volcano", "value": "Volcano", "description": "A mountain or hill formed by volcanic activity, typically with a crater at its summit." }, { "name": "Walkway", "value": "Walkway", "description": "A path or paved surface designated for pedestrian use." }, { "name": "Wall", "value": "Wall", "description": "A constructed barrier forming a continuous vertical boundary, often used for defense,\nseparation, or commemoration. Availability varies by geography and might change as\nAzure Maps search data is updated. Matching suggestions aren't guaranteed for every\nquery." }, { "name": "Waterfall", "value": "Waterfall", "description": "A point where a stream or river drops vertically or steeply." }, { "name": "WaterFeature", "value": "WaterFeature", "description": "A body of water that doesn't fit a more specific category, such as a `Lake`, `River`,\nor `Sea`." }, { "name": "Wetland", "value": "Wetland", "description": "An area of land saturated with water and supporting aquatic vegetation, such as a marsh\nor swamp." }, { "name": "Winery", "value": "Winery", "description": "A facility where wine is produced and often offered for tasting or sale." }, { "name": "Zoo", "value": "Zoo", "description": "A facility where wild animals are kept for public exhibition and study." } ] } }, "AutocompleteResultTypeGroupsEnum": { "type": "string", "description": "A coarse classification of an autocomplete suggestion into one of two groups. Used by\n`Get Autocomplete` both as an input filter via the `resultTypeGroups` query parameter\n(restricting which kinds of suggestions are returned) and as an output classifier via\nthe `typeGroup` field on each `AutocompleteProperties` (identifying which group a\nreturned suggestion belongs to). The `Address` group covers individual addresses and\nstreet segments; the `Place` group covers all other entity types (administrative\nregions, populated places, natural features, and points of interest).", "enum": [ "Address", "Place" ], "x-ms-enum": { "name": "AutocompleteResultTypeGroupsEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "Suggestions that resolve to a specific address or a road segment." }, { "name": "Place", "value": "Place", "description": "Suggestions that resolve to named places, including administrative regions, populated\nplaces, neighborhoods, natural features, and points of interest. Examples include\n`AdminDivision1`, `Neighborhood`, and `PopulatedPlace`." } ] } }, "Azure.Core.Foundations.Error": { "type": "object", "description": "The error object.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" } }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "An object containing more specific information than the current object about the error." } }, "required": [ "code", "message" ] }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } } }, "Boundary": { "type": "object", "description": "The successful response body returned by `Get Polygon`. Encoded as a\n[`GeoJSON Feature`](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) whose `geometry` is\na `GeometryCollection` of one or more `Polygon` or `MultiPolygon` shapes describing the\noutline of the requested geographical area, and whose `properties` carry the area's\ndisplay name and copyright attribution.", "properties": { "type": { "$ref": "#/definitions/FeatureTypeEnum", "description": "The `GeoJSON` object type. Always `Feature`, as defined in\n[RFC 7946](https://www.rfc-editor.org/rfc/rfc7946)." }, "geometry": { "$ref": "#/definitions/GeoJsonGeometryCollection", "description": "A `GeometryCollection` of one or more `Polygon` or `MultiPolygon` shapes whose coordinates\ndefine the outline of the requested area in WGS 84 longitude/latitude order, as defined\nby [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.8)." }, "properties": { "$ref": "#/definitions/BoundaryProperties", "description": "Display name and copyright attribution for the returned area. See `BoundaryProperties`\nfor the per-property shape." } }, "required": [ "geometry" ] }, "BoundaryProperties": { "type": "object", "description": "The `properties` payload of a `Boundary`. Carries the display name of the returned\ngeographical area along with copyright attribution, both an API-wide notice and\nper-geometry data-provider credits.", "properties": { "name": { "type": "string", "description": "The display name of the geographical area, for example, `\"Bellevue\"` for a city boundary." }, "copyright": { "type": "string", "description": "The Azure Maps API copyright and usage notice that applies to this response. Distinct\nfrom the per-geometry data-provider attributions in `geometriesCopyright`." }, "copyrightUrl": { "type": "string", "description": "A URL to Azure Maps copyright and licensing information for the API and its underlying\ndata sources." }, "geometriesCopyright": { "type": "array", "description": "Per-geometry data-provider attribution. Each entry corresponds positionally to the\nmatching shape in the parent `Boundary.geometry.geometries` array — entry `i` describes\nthe source of geometry `i`.", "items": { "$ref": "#/definitions/GeometryCopyright" } } } }, "BoundaryResultTypeEnum": { "type": "string", "description": "The geographic hierarchy level requested when calling `Get Polygon`. The value is supplied\nas the `resultType` query parameter and selects which level of the administrative or postal\nhierarchy the returned `Boundary` polygon outlines. Defaults to `countryRegion` when not\nspecified.", "enum": [ "countryRegion", "adminDistrict", "adminDistrict2", "postalCode", "postalCode2", "postalCode3", "postalCode4", "neighborhood", "locality" ], "x-ms-enum": { "name": "BoundaryResultTypeEnum", "modelAsString": true, "values": [ { "name": "countryRegion", "value": "countryRegion", "description": "A country or region." }, { "name": "adminDistrict", "value": "adminDistrict", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "adminDistrict2", "value": "adminDistrict2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "postalCode", "value": "postalCode", "description": "The smallest postal code category, such as a zip code." }, { "name": "postalCode2", "value": "postalCode2", "description": "The next largest postal code category after `postalCode` that is created by aggregating\n`postalCode` areas." }, { "name": "postalCode3", "value": "postalCode3", "description": "The next largest postal code category after `postalCode2` that is created by aggregating\n`postalCode2` areas." }, { "name": "postalCode4", "value": "postalCode4", "description": "The next largest postal code category after `postalCode3` that is created by aggregating\n`postalCode3` areas." }, { "name": "neighborhood", "value": "neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "locality", "value": "locality", "description": "A concentrated area of human settlement, such as a city, town or village." } ] } }, "CalculationMethodEnum": { "type": "string", "description": "The method that was used to compute the geocode point.", "enum": [ "Interpolation", "InterpolationOffset", "Parcel", "Rooftop" ], "x-ms-enum": { "name": "CalculationMethodEnum", "modelAsString": true, "values": [ { "name": "Interpolation", "value": "Interpolation", "description": "The geocode point was matched to a point on a road using interpolation." }, { "name": "InterpolationOffset", "value": "InterpolationOffset", "description": "The geocode point was matched to a point on a road using interpolation with an additional\noffset to shift the point to the side of the street." }, { "name": "Parcel", "value": "Parcel", "description": "The geocode point was matched to the center of a parcel." }, { "name": "Rooftop", "value": "Rooftop", "description": "The geocode point was matched to the rooftop of a building." } ] } }, "ConfidenceEnum": { "type": "string", "description": "The level of confidence that the geocoded location result is a match. Use this value together\nwith the match codes to obtain more complete information about the match.\n\nThe confidence of a geocoded location is based on many factors, including the relative\nimportance of the geocoded location and the user's location, if specified.", "enum": [ "High", "Medium", "Low" ], "x-ms-enum": { "name": "ConfidenceEnum", "modelAsString": true, "values": [ { "name": "High", "value": "High", "description": "If the confidence is set to `High`, one or more strong matches were found. Multiple `High`\nconfidence matches are sorted in ranked order by importance when applicable. For example,\nlandmarks have importance but addresses do not.\n\nIf a request includes a location or a view, then the ranking may change accordingly. For\nexample, a location query for \"Paris\" returns both \"Paris, France\" and \"Paris, TX\" with\n`High` confidence. \"Paris, France\" is always ranked first due to importance, unless a user\nlocation indicates that the user is in or very close to Paris, TX, or the map view indicates\nthat the user is searching in that area." }, { "name": "Medium", "value": "Medium", "description": "In some situations, the returned match may not be at the same level as the information\nprovided in the request. For example, a request may specify address information and the\ngeocode service may only be able to match a postal code. In this case, if the geocode\nservice has confidence that the postal code matches the data, the confidence is set to\n`Medium` and the match code is set to `UpHierarchy` to indicate that the service could not\nmatch all of the information and had to search up-hierarchy.\n\nIf the location information in the query is ambiguous, and there is no additional information\nto rank the locations (such as user location or the relative importance of the location), the\nconfidence is set to `Medium`. For example, a location query for \"148th Ave, Bellevue\" may\nreturn both \"148th Ave SE\" and \"148th Ave NE\" with `Medium` confidence.\n\nIf the location information in the query does not provide enough information to geocode a\nspecific location, a less precise location value may be returned and the confidence is set to\n`Medium`. For example, if an address is provided but a match is not found for the house\nnumber, the geocode result with a `RoadBlock` entity type may be returned." }, { "name": "Low", "value": "Low", "description": "Low confidence in the match." } ] } }, "ErrorAdditionalInfo": { "type": "object", "description": "The resource management error additional info.", "properties": { "type": { "type": "string", "description": "The additional info type.", "readOnly": true }, "info": { "type": "object", "description": "The additional info.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "ErrorDetail": { "type": "object", "description": "The error detail.", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "target": { "type": "string", "description": "The error target.", "readOnly": true }, "details": { "type": "array", "description": "The error details.", "items": { "$ref": "#/definitions/ErrorDetail" }, "readOnly": true }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "#/definitions/ErrorAdditionalInfo" }, "readOnly": true } } }, "ErrorResponse": { "type": "object", "description": "Common error response for all Azure Resource Manager APIs to return error\ndetails for failed operations. (This also follows the OData error response\nformat.).", "properties": { "error": { "$ref": "#/definitions/ErrorDetail", "description": "The error object." } } }, "FeatureCollectionEnum": { "type": "string", "description": "The `GeoJSON` object type used at the root of successful responses from the forward\ngeocoding, reverse geocoding, and autocomplete operations (including their batch\nvariants). The only value is `FeatureCollection`, as defined in\n[RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). `Get Polygon` is the one exception:\nits response root is a `GeoJSON Feature`, see `FeatureTypeEnum`.", "enum": [ "FeatureCollection" ], "x-ms-enum": { "name": "FeatureCollectionEnum", "modelAsString": true, "values": [ { "name": "FeatureCollection", "value": "FeatureCollection", "description": "The `GeoJSON FeatureCollection` object type. Appears as the root of every successful\ngeocoding, reverse geocoding, and autocomplete response body. `Get Polygon` uses a\n`Feature` root instead." } ] } }, "FeatureTypeEnum": { "type": "string", "description": "The `GeoJSON` object type for `Feature` objects. Tags each entry inside the `features`\narray of a `FeatureCollection` response (geocoding, reverse geocoding, autocomplete) and\nappears at the root of the `Get Polygon` response. The only value is `Feature`, as\ndefined in [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).", "enum": [ "Feature" ], "x-ms-enum": { "name": "FeatureTypeEnum", "modelAsString": true, "values": [ { "name": "Feature", "value": "Feature", "description": "The `GeoJSON Feature` object type. Appears on every Feature inside a `FeatureCollection`\nresponse, and at the root of the `Get Polygon` response." } ] } }, "FeaturesItem": { "type": "object", "description": "A single entry in the `features` array of a `GeocodingResponse`, conforming to the\n[`GeoJSON Feature`](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) object shape.\nRepresents one geocoded location: structured data on `properties`, a representative\ncoordinate on `geometry`, and an optional bounding box on `bbox`.", "properties": { "type": { "$ref": "#/definitions/FeatureTypeEnum", "description": "The `GeoJSON` object type. Always `Feature`, as defined in\n[RFC 7946](https://www.rfc-editor.org/rfc/rfc7946)." }, "id": { "type": "string", "description": "An optional service-assigned identifier for the feature, when one is available." }, "properties": { "$ref": "#/definitions/FeaturesItemProperties", "description": "Structured data about the geocoded location, including its entity type, match-quality\nindicators, address components, and one or more geocode points." }, "geometry": { "$ref": "#/definitions/GeoJsonPoint", "description": "The primary [`GeoJSON Point`](https://tools.ietf.org/html/rfc7946#section-3.1.2)\nrepresenting the geocoded location, with coordinates in WGS 84 longitude/latitude order." }, "bbox": { "type": "array", "description": "The smallest axis-aligned rectangle that contains the feature's geometry, in WGS 84\nlongitude/latitude order. Encoded as `[westLon, southLat, eastLon, northLat]` per\n[RFC 7946, Section 5](https://datatracker.ietf.org/doc/html/rfc7946#section-5).", "items": { "type": "number", "format": "double" } } }, "required": [ "geometry" ] }, "FeaturesItemProperties": { "type": "object", "description": "The `properties` payload of a feature in a `GeocodingResponse`. Carries the entity type and\nmatch-quality indicators for the geocoded location, its parsed address components, and one or\nmore geocode points that pin the location to specific coordinates.", "properties": { "type": { "type": "string", "description": "The entity type that the geocoded location resolved to. One of: `Address`, `RoadBlock`,\n`RoadIntersection`, `Neighborhood`, `PopulatedPlace`, `Postcode1`, `AdminDivision1`,\n`AdminDivision2`, or `CountryRegion`." }, "confidence": { "$ref": "#/definitions/ConfidenceEnum", "description": "How strongly the geocoded location matches the request. Use together with `matchCodes` for a\ncomplete picture of match quality. See `ConfidenceEnum` for the value list and the factors\nthat influence the rating." }, "matchCodes": { "type": "array", "description": "How the geocoding service produced this result relative to the query: a direct match at the\nrequested specificity (`Good`), one of several candidates (`Ambiguous`), or a fallback to a\nless precise level of the geographic hierarchy (`UpHierarchy`). Multiple values may be\npresent. For example, an `Ambiguous` plus `UpHierarchy` pairing indicates that the service\ncould not match the requested specificity and found multiple matches at a coarser level. See\n`MatchCodesEnum` for per-value descriptions; combine with `confidence` for a complete\npicture of match quality.", "items": { "$ref": "#/definitions/MatchCodesEnum" } }, "address": { "$ref": "#/definitions/Address", "description": "The address of the geocoded location, parsed into structured fields such as locality, postal\ncode, country/region, and (when available) street name and number." }, "geocodePoints": { "type": "array", "description": "One or more geocode points for the location, each marked with how it was derived\n(`calculationMethod`) and what it is best suited for (`usageTypes`). For example, `Display`\nfor visual placement on a map, or `Route` for use as a navigation destination.", "items": { "$ref": "#/definitions/GeocodePointsItem" } } } }, "GeoJsonGeometry": { "type": "object", "description": "A valid `GeoJSON` geometry object. The type must be one of the seven valid\nGeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString,\nPolygon, MultiPolygon and GeometryCollection. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", "properties": { "type": { "$ref": "#/definitions/GeoJsonObjectType", "description": "Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object\ntypes - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,\nGeometryCollection, Feature and FeatureCollection." }, "bbox": { "type": "array", "description": "Bounding box. Projection used - EPSG:3857. Please refer to [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946#section-5) for details.", "minItems": 4, "maxItems": 4, "items": { "type": "number", "format": "double" } } }, "discriminator": "type", "required": [ "type" ] }, "GeoJsonGeometryCollection": { "type": "object", "description": "A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details.", "properties": { "geometries": { "type": "array", "description": "Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates\nin GeoJSON are in x, y order (longitude, latitude).", "items": { "$ref": "#/definitions/GeoJsonGeometry" } } }, "required": [ "geometries" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "GeometryCollection" }, "GeoJsonLineString": { "type": "object", "description": "A valid `GeoJSON LineString` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson LineString` geometry.", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "LineString" }, "GeoJsonMultiLineString": { "type": "object", "description": "A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson MultiLineString` geometry.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiLineString" }, "GeoJsonMultiPoint": { "type": "object", "description": "A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson MultiPoint` geometry.", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiPoint" }, "GeoJsonMultiPolygon": { "type": "object", "description": "A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details.", "properties": { "coordinates": { "type": "array", "description": "Contains a list of valid `GeoJSON Polygon` objects. **Note** that coordinates\nin GeoJSON are in x, y order (longitude, latitude).", "items": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "MultiPolygon" }, "GeoJsonObjectType": { "type": "string", "description": "Specifies the `GeoJSON` type. Must be one of the nine valid GeoJSON object\ntypes - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon,\nGeometryCollection, Feature and FeatureCollection.", "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ], "x-ms-enum": { "name": "GeoJsonObjectType", "modelAsString": false, "values": [ { "name": "GeoJsonPoint", "value": "Point", "description": "`GeoJSON Point` geometry." }, { "name": "GeoJsonMultiPoint", "value": "MultiPoint", "description": "`GeoJSON MultiPoint` geometry." }, { "name": "GeoJsonLineString", "value": "LineString", "description": "`GeoJSON LineString` geometry." }, { "name": "GeoJsonMultiLineString", "value": "MultiLineString", "description": "`GeoJSON MultiLineString` geometry." }, { "name": "GeoJsonPolygon", "value": "Polygon", "description": "`GeoJSON Polygon` geometry." }, { "name": "GeoJsonMultiPolygon", "value": "MultiPolygon", "description": "`GeoJSON MultiPolygon` geometry." }, { "name": "GeoJsonGeometryCollection", "value": "GeometryCollection", "description": "`GeoJSON GeometryCollection` geometry." }, { "name": "GeoJsonFeature", "value": "Feature", "description": "`GeoJSON Feature` object." }, { "name": "GeoJsonFeatureCollection", "value": "FeatureCollection", "description": "`GeoJSON FeatureCollection` object." } ] } }, "GeoJsonPoint": { "type": "object", "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", "properties": { "coordinates": { "type": "array", "description": "A `Position` is an array of numbers with two or more elements. The first two\nelements are _longitude_ and _latitude_, precisely in that order.\n_Altitude/Elevation_ is an optional third element. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", "items": { "type": "number", "format": "double" } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "Point" }, "GeoJsonPolygon": { "type": "object", "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC\n7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", "properties": { "coordinates": { "type": "array", "description": "Coordinates for the `GeoJson Polygon` geometry type.", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number", "format": "double" } } } } }, "required": [ "coordinates" ], "allOf": [ { "$ref": "#/definitions/GeoJsonGeometry" } ], "x-ms-discriminator-value": "Polygon" }, "GeocodePointsItem": { "type": "object", "description": "One geocode point for a location: a coordinate plus metadata describing how the point was\ncomputed (`calculationMethod`) and what it is best suited for (`usageTypes`). A single feature\ntypically returns separate `Display` and `Route` points so callers can pick the one that fits\nthe task.", "properties": { "geometry": { "$ref": "#/definitions/GeoJsonPoint", "description": "The coordinate of this geocode point as a\n[`GeoJSON Point`](https://tools.ietf.org/html/rfc7946#section-3.1.2), with values in WGS 84\nlongitude/latitude order." }, "calculationMethod": { "$ref": "#/definitions/CalculationMethodEnum", "description": "How the point was computed. For example, snapped to the rooftop of a building or\ninterpolated along a road centerline. See `CalculationMethodEnum` for the value list." }, "usageTypes": { "type": "array", "description": "What the geocode point is best suited for — `Display` for visual placement on a map, or\n`Route` as a routing destination. A point may carry both. See `UsageTypeEnum` for the\nper-value details, including how each is positioned for features with non-trivial extent.", "items": { "$ref": "#/definitions/UsageTypeEnum" } } } }, "GeocodingBatchRequestBody": { "type": "object", "description": "The request body for the `Get Geocoding Batch` operation. Carries one or more individual\ngeocoding queries — between 1 and 100, inclusive — that the service processes as a single\ncall and returns as a parallel `batchItems` array on `GeocodingBatchResponse`.", "properties": { "batchItems": { "type": "array", "description": "The geocoding queries to process in this batch. Each entry is one independent\nforward-geocoding request; the service returns one corresponding entry in\n`GeocodingBatchResponse.batchItems` per query, in the same order.", "items": { "$ref": "#/definitions/GeocodingBatchRequestItem" } } } }, "GeocodingBatchRequestItem": { "type": "object", "description": "One geocoding query inside a `GeocodingBatchRequestBody.batchItems` array. Each item is an\nindependent forward-geocoding request equivalent to a single call to `Get Geocoding`, expressed\nas fields rather than as URL query parameters. The location can be supplied either as a\nfree-form `query` string or as the structured fields below (`addressLine`, `locality`,\n`countryRegion`, the `adminDistrict` levels, `postalCode`); these two input modes are mutually\nexclusive — when `query` is set, the structured fields are ignored.", "properties": { "optionalId": { "type": "string", "description": "An optional caller-supplied identifier echoed back on the matching response entry as\n`GeocodingBatchResponseItem.optionalId`. Useful for correlating responses to requests by a\nstable application-side identifier rather than relying on array position alone." }, "top": { "type": "integer", "format": "int32", "description": "The maximum number of geocoded results returned for this query. Defaults to 5; minimum 1,\nmaximum 20.", "default": 5, "minimum": 1, "maximum": 20 }, "query": { "type": "string", "description": "A free-form string describing the location to geocode, typically an address or landmark\nname. When set, the structured location fields below (`addressLine`, `locality`,\n`countryRegion`, the `adminDistrict` levels, `postalCode`) are ignored." }, "addressLine": { "type": "string", "description": "The street line of the address, typically the street name and number, or any other\nofficial street-level address. Ignored when `query` is set." }, "countryRegion": { "type": "string", "description": "An [ISO 3166-1 Alpha-2 region/country\ncode](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) that scopes the search to a single\ncountry or region. For example, `\"FR\"` for France. Ignored when `query` is set." }, "bbox": { "type": "array", "description": "A bounding box that scopes the search to a rectangular geographic area. Encoded as\n`[westLon, southLat, eastLon, northLat]` in WGS 84 longitude/latitude order, with each side\nranging from approximately `0.00001` degrees (~1 meter) up to the full global extent\n(`-180, -90` to `180, 90`).", "items": { "type": "number", "format": "double" } }, "view": { "type": "string", "description": "An [ISO 3166-1 Alpha-2 region/country\ncode](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) identifying the region whose\ngeopolitical view should be applied to disputed borders and labels in the response. Defaults\nto `\"auto\"`, which selects the view based on the request origin. See [Supported\nViews](https://aka.ms/AzureMapsLocalizationViews) for the available values.", "default": "auto" }, "coordinates": { "type": "array", "description": "A point on the earth, encoded as `[longitude, latitude]` in WGS 84 order, used to bias\nresults toward the user's location. When supplied, results closer to this point are\ntypically more relevant to the user.", "items": { "type": "number", "format": "double" } }, "adminDistrict": { "type": "string", "description": "The first-order administrative subdivision (such as a state or province) supplied as a name\nor short code. For example, `\"WA\"` for Washington. Ignored when `query` is set." }, "adminDistrict2": { "type": "string", "description": "The second-order administrative subdivision (such as a county). For example, `\"King\"` for\nKing County. Ignored when `query` is set." }, "adminDistrict3": { "type": "string", "description": "The third-order administrative subdivision (such as a district, parish, or municipality),\nwhere the country, dependency, or region defines one. Ignored when `query` is set." }, "locality": { "type": "string", "description": "The locality (city, town, or village) component of the address. For example, `\"Seattle\"`.\nIgnored when `query` is set." }, "postalCode": { "type": "string", "description": "The postal code component of the address. Ignored when `query` is set." } } }, "GeocodingBatchResponse": { "type": "object", "description": "The successful response body returned by `Get Geocoding Batch`. Carries a `summary` of how\nmany of the submitted queries succeeded plus a `batchItems` array containing one response\nentry per query in the request, in the same order as the request `batchItems` array.", "properties": { "summary": { "$ref": "#/definitions/GeocodingBatchResponseSummary", "description": "Aggregate counts for the batch as a whole, the total submitted queries and how many of\nthem completed successfully." }, "batchItems": { "type": "array", "description": "The per-query results of the batch. Each entry corresponds positionally to the request\nentry at the same array index in `GeocodingBatchRequestBody.batchItems`. Entries with\n`error` populated represent queries that failed; entries with `features` populated\nrepresent queries that succeeded.", "items": { "$ref": "#/definitions/GeocodingBatchResponseItem" } }, "nextLink": { "type": "string", "description": "Contains the URL to fetch the next page of results if the response is paginated. This is\nuseful when the response is too large to be returned in a single call, allowing users to\nnavigate through multiple pages of results." } } }, "GeocodingBatchResponseItem": { "type": "object", "description": "A single entry inside `GeocodingBatchResponse.batchItems`, carrying the result of one of\nthe queries from the corresponding `GeocodingBatchRequestBody.batchItems` entry.\nSuccessful queries surface their geocoded `features` here in the same shape as\n`GeocodingResponse`; failed queries surface diagnostic information via `error` instead.\nExactly one of `features` or `error` is populated per entry.", "properties": { "optionalId": { "type": "string", "description": "The caller-supplied identifier echoed back from the corresponding\n`GeocodingBatchRequestItem.optionalId`. Populated only when the request entry supplied\none. Useful for application-side correlation when array position is not sufficient." }, "type": { "$ref": "#/definitions/FeatureCollectionEnum", "description": "The `GeoJSON` object type of this entry's success body. Always `FeatureCollection`, as\ndefined in [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). Populated only when the\nentry succeeded." }, "features": { "type": "array", "description": "The array of `GeoJSON Feature` objects geocoded for this batch entry's query. Each\n`Feature` represents a single geocoded location with details exposed via `properties` and\nits primary coordinate via `geometry`. Populated only when the entry succeeded.", "items": { "$ref": "#/definitions/FeaturesItem" } }, "nextLink": { "type": "string", "description": "Contains the URL to fetch the next page of results if the response is paginated. This is\nuseful when the response is too large to be returned in a single call, allowing users to\nnavigate through multiple pages of results." }, "error": { "$ref": "#/definitions/ErrorDetail", "description": "Diagnostic information for a query that failed inside the batch, the per-entry error\npath complementing the success path on `features`. Populated only when the entry failed;\nsee `ErrorDetail` for the per-error shape." } } }, "GeocodingBatchResponseSummary": { "type": "object", "description": "Carries aggregate counts for a `Get Geocoding Batch` response: the size of the submitted\nbatch and how many of its queries were processed successfully. Used as the type of\n`GeocodingBatchResponse.summary`.", "properties": { "successfulRequests": { "type": "integer", "format": "int32", "description": "The number of queries in the batch that were processed successfully — those whose response\nentry in `GeocodingBatchResponse.batchItems` carries `features` rather than `error`." }, "totalRequests": { "type": "integer", "format": "int32", "description": "The total number of queries submitted in the batch. Subtract `successfulRequests` to derive\nthe number of queries that failed." } } }, "GeocodingResponse": { "type": "object", "description": "The successful response body returned by `Get Geocoding` and `Get Reverse Geocoding`, and\nthe per-batch-item success shape carried inside `GeocodingBatchResponse.batchItems`.\nEncoded as a [`GeoJSON FeatureCollection`](https://www.rfc-editor.org/rfc/rfc7946) whose\n`features` array contains one `Feature` per geocoded location.", "properties": { "type": { "$ref": "#/definitions/FeatureCollectionEnum", "description": "The `GeoJSON` object type of a successful `Get Geocoding` or `Get Reverse Geocoding`\nresponse body. Always `FeatureCollection`, as defined in\n[RFC 7946](https://www.rfc-editor.org/rfc/rfc7946)." }, "features": { "type": "array", "description": "The array of `GeoJSON Feature` objects returned by the query. Each `Feature` represents a\nsingle geocoded location: its address components, match-quality indicators, and geocode\npoints are exposed via `properties`, and its primary coordinate via `geometry`.", "items": { "$ref": "#/definitions/FeaturesItem" } }, "nextLink": { "type": "string", "description": "Contains the URL to fetch the next page of results if the response is paginated. This is\nuseful when the response is too large to be returned in a single call, allowing users to\nnavigate through multiple pages of results." } } }, "GeometryCopyright": { "type": "object", "description": "A single per-geometry data-provider attribution entry within\n`BoundaryProperties.geometriesCopyright`. Identifies the source of one geometry in\nthe parent `Boundary.geometry.geometries` array.", "properties": { "sourceName": { "type": "string", "description": "An identifier for the data provider that supplied this geometry." }, "copyright": { "type": "string", "description": "The human-readable attribution string for the data provider. For example, `\"TomTom\"`.\nMay be a vendor name or a fuller copyright notice." } } }, "Intersection": { "type": "object", "description": "Intersection details for an address resolved as a road intersection — the corner where two or\nmore named streets meet. Populated only when the resolved entity is a `RoadIntersection`; the\nparent `Address.intersection` is otherwise omitted.", "properties": { "baseStreet": { "type": "string", "description": "The primary street of the intersection — typically the street the address number references." }, "secondaryStreet1": { "type": "string", "description": "The first cross street that meets `baseStreet` at the intersection." }, "secondaryStreet2": { "type": "string", "description": "The second cross street at the intersection, when one is present. Populated only for\nintersections of three or more streets." }, "intersectionType": { "type": "string", "description": "A short label describing the form of the intersection. For example, distinguishing an\nat-grade crossroads from a grade-separated crossing such as a bridge or overpass." }, "displayName": { "type": "string", "description": "A human-readable name for the intersection that combines the cross streets, such as\n`\"5th Avenue & Main Street\"`." } } }, "MatchCodesEnum": { "type": "string", "description": "A match-code value indicating how the geocoding service produced a particular location\nresult. The `matchCodes` field on a feature is an array of these values; combine them with\n`confidence` and `type` to evaluate match quality.", "enum": [ "Good", "Ambiguous", "UpHierarchy" ], "x-ms-enum": { "name": "MatchCodesEnum", "modelAsString": true, "values": [ { "name": "Good", "value": "Good", "description": "The geocoding service produced this candidate without broadening the query: the result\nmatches the query at the specificity that was requested." }, { "name": "Ambiguous", "value": "Ambiguous", "description": "The location is one of a set of possible matches. For example, when querying for the\nstreet address \"128 Main St.\", the response may return two locations for \"128 North Main\nSt.\" and \"128 South Main St.\" because there is not enough information to determine which\noption to choose." }, { "name": "UpHierarchy", "value": "UpHierarchy", "description": "The location represents a move up the geographic hierarchy. This occurs when a match for\nthe location request was not found, so a less precise result is returned." } ] } }, "ResolutionEnum": { "type": "string", "description": "The level of detail used for the `Boundary` polygon returned by `Get Polygon`. Supplied as\nthe `resolution` query parameter, the value selects how many points outline the boundary,\nin ascending order: `small`, `medium`, `large`, `huge`. Higher levels use the same number\nof points as the next lower level or more. Defaults to `medium` when not specified.", "enum": [ "small", "medium", "large", "huge" ], "x-ms-enum": { "name": "ResolutionEnum", "modelAsString": true, "values": [ { "name": "small", "value": "small", "description": "Returns the boundary geometry with the fewest points." }, { "name": "medium", "value": "medium", "description": "Returns the boundary geometry with the same number of points as `small` or more." }, { "name": "large", "value": "large", "description": "Returns the boundary geometry with the same number of points as `medium` or more." }, { "name": "huge", "value": "huge", "description": "Returns the boundary geometry with the same number of points as `large` or more." } ] } }, "ResultTypeEnum": { "type": "string", "description": "An entity type returned by the `Get Reverse Geocoding Batch` operation. Supplied as one or\nmore values in the per-batch-item `resultTypes` field to restrict the response for that\nitem to specific kinds of locations; when the field is omitted, all entity types are\neligible. When entities of more than one type match a coordinate, only the most specific\nis returned. Listed from most specific to least specific: `Address`, `Neighborhood`,\n`PopulatedPlace`, `Postcode1`, `AdminDivision1`, `AdminDivision2`, `CountryRegion`.", "enum": [ "Address", "Neighborhood", "PopulatedPlace", "Postcode1", "AdminDivision1", "AdminDivision2", "CountryRegion" ], "x-ms-enum": { "name": "ResultTypeEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "A specific street address." }, { "name": "Neighborhood", "value": "Neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "PopulatedPlace", "value": "PopulatedPlace", "description": "A concentrated area of human settlement, such as a city, town or village." }, { "name": "Postcode1", "value": "Postcode1", "description": "The smallest postal code category, such as a zip code." }, { "name": "AdminDivision1", "value": "AdminDivision1", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "AdminDivision2", "value": "AdminDivision2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "CountryRegion", "value": "CountryRegion", "description": "A country or region." } ] } }, "ReverseGeocodingBatchRequestBody": { "type": "object", "description": "The request body for the `Get Reverse Geocoding Batch` operation. Carries one or more\nindividual reverse-geocoding queries — between 1 and 100, inclusive — that the service\nprocesses as a single call and returns as a parallel `batchItems` array on\n`GeocodingBatchResponse`.", "properties": { "batchItems": { "type": "array", "description": "The reverse-geocoding queries to process in this batch. Each entry is one independent\nreverse-geocoding request; the service returns one corresponding entry in\n`GeocodingBatchResponse.batchItems` per query, in the same order.", "items": { "$ref": "#/definitions/ReverseGeocodingBatchRequestItem" } } } }, "ReverseGeocodingBatchRequestItem": { "type": "object", "description": "One reverse-geocoding query inside a `ReverseGeocodingBatchRequestBody.batchItems` array.\nEach item is an independent reverse-geocoding request equivalent to a single call to\n`Get Reverse Geocoding`, expressed as fields rather than as URL query parameters. Specify\nthe location to reverse-geocode via `coordinates`; optionally narrow the entity types via\n`resultTypes` and the geopolitical view via `view`.", "properties": { "optionalId": { "type": "string", "description": "An optional caller-supplied identifier echoed back on the matching response entry as\n`GeocodingBatchResponseItem.optionalId`. Useful for correlating responses to requests by a\nstable application-side identifier rather than relying on array position alone." }, "coordinates": { "type": "array", "description": "The location to reverse-geocode, encoded as `[longitude, latitude]` in WGS 84 order. For\nexample, `[-122.138681, 47.630358]` for a point in Redmond, Washington.", "items": { "type": "number", "format": "double" } }, "resultTypes": { "type": "array", "description": "Restricts the response to specific kinds of locations. When omitted, all entity types are\neligible. See `ResultTypeEnum` for the value list and the most-specific-wins selection\nbehavior when entities of multiple types match.", "items": { "$ref": "#/definitions/ResultTypeEnum" } }, "view": { "type": "string", "description": "An [ISO 3166-1 Alpha-2 region/country\ncode](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) identifying the region whose\ngeopolitical view should be applied to disputed borders and labels in the response. See\n[Supported Views](https://aka.ms/AzureMapsLocalizationViews) for the available values." } } }, "ReverseGeocodingResultTypeEnum": { "type": "string", "description": "An entity type returned by the `Get Reverse Geocoding` operation. Supplied as one or more\nvalues in the `resultTypes` query parameter to restrict the response to specific kinds of\nlocations; when the parameter is omitted, all entity types are eligible. When entities of\nmore than one type match a coordinate, only the most specific is returned. Listed from\nmost specific to least specific: `Address`, `Neighborhood`, `PopulatedPlace`, `Postcode1`,\n`AdminDivision1`, `AdminDivision2`, `CountryRegion`.", "enum": [ "Address", "Neighborhood", "PopulatedPlace", "Postcode1", "AdminDivision1", "AdminDivision2", "CountryRegion" ], "x-ms-enum": { "name": "ReverseGeocodingResultTypeEnum", "modelAsString": true, "values": [ { "name": "Address", "value": "Address", "description": "A specific street address." }, { "name": "Neighborhood", "value": "Neighborhood", "description": "A locally recognized area within a populated place, often with informal or culturally\ndefined boundaries." }, { "name": "PopulatedPlace", "value": "PopulatedPlace", "description": "A concentrated area of human settlement, such as a city, town or village." }, { "name": "Postcode1", "value": "Postcode1", "description": "The smallest postal code category, such as a zip code." }, { "name": "AdminDivision1", "value": "AdminDivision1", "description": "First administrative level within the country/region, such as a state or a province." }, { "name": "AdminDivision2", "value": "AdminDivision2", "description": "Second administrative level within the country/region, such as a county." }, { "name": "CountryRegion", "value": "CountryRegion", "description": "A country or region." } ] } }, "UsageTypeEnum": { "type": "string", "description": "The intended use for a geocode point. A geocode point returned by the service carries one or\nmore usage types that indicate how a client application should consume the point: for\nexample, displaying the location on a map versus routing a vehicle to it.", "enum": [ "Display", "Route" ], "x-ms-enum": { "name": "UsageTypeEnum", "modelAsString": true, "values": [ { "name": "Display", "value": "Display", "description": "The geocode point is suitable for displaying the location on a map. For a feature with\nnon-trivial extent (such as a park or building), the `Display` point is typically near the\nvisual center of the feature." }, { "name": "Route", "value": "Route", "description": "The geocode point is suitable as the destination of a route. For a feature with\nnon-trivial extent (such as a park or building), the `Route` point is typically positioned\nat a vehicle-accessible entrance rather than at the visual center." } ] } } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" } } }