{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Search API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Post Search Autocomplete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/autocomplete", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." } ] }, "docs": "Get auto complete options." }, { "info": { "name": "Microsoft Azure Post Search Query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/query", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." } ] }, "docs": "Get data using search." }, { "info": { "name": "Microsoft Azure Post Search Suggest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/suggest", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." } ] }, "docs": "Get search suggestions by query criteria." }, { "info": { "name": "Microsoft Azure Get Search Polygon Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/polygon/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "geometries", "value": "", "type": "query", "description": "Comma separated list of geometry UUIDs, previously retrieved from an Online Search request." } ] }, "docs": "**Get Polygon**


**Applies to**: S1 pricing tier.


The Get Polygon service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the dataSources object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.

Please note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. Th" }, { "info": { "name": "Microsoft Azure Get Search Fuzzy Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/fuzzy/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The applicable query string (e.g., \"seattle\", \"pizza\"). Can _also_ be specified as a comma separated string composed by latitude followed by longitude (e.g., \"47.641268, -122.125679\"). Must be properly URL encoded." }, { "name": "typeahead", "value": "", "type": "query", "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "countrySet", "value": "", "type": "query", "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries" }, { "name": "lat", "value": "", "type": "query", "description": "Latitude where results should be biased. E.g. 37.337" }, { "name": "lon", "value": "", "type": "query", "description": "Longitude where results should be biased. E.g. -121.89" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "topLeft", "value": "", "type": "query", "description": "Top left position of the bounding box. E.g. 37.553,-122.453" }, { "name": "btmRight", "value": "", "type": "query", "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "minFuzzyLevel", "value": "", "type": "query", "description": "Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel." }, { "name": "maxFuzzyLevel", "value": "", "type": "query", "description": "Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel." }, { "name": "idxSet", "value": "", "type": "query", "description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)" }, { "name": "brandSet", "value": "", "type": "query", "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar" }, { "name": "connectorSet", "value": "", "type": "query", "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." }, { "name": "openingHours", "value": "", "type": "query", "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays" } ] }, "docs": "
**Free Form Search**

**Applies to**: S0 and S1 pricing tiers.


The basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more" }, { "info": { "name": "Microsoft Azure Get Search Poi Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/poi/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\"), must be properly URL encoded." }, { "name": "typeahead", "value": "", "type": "query", "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "countrySet", "value": "", "type": "query", "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries" }, { "name": "lat", "value": "", "type": "query", "description": "Latitude where results should be biased. E.g. 37.337" }, { "name": "lon", "value": "", "type": "query", "description": "Longitude where results should be biased. E.g. -121.89" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "topLeft", "value": "", "type": "query", "description": "Top left position of the bounding box. E.g. 37.553,-122.453" }, { "name": "btmRight", "value": "", "type": "query", "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **POI** = Points of Interest \n\nValue should be **POI** or **None** to disable extended postal codes.\n\nBy default extended postal codes are included.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "brandSet", "value": "", "type": "query", "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar" }, { "name": "connectorSet", "value": "", "type": "query", "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." }, { "name": "openingHours", "value": "", "type": "query", "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays" } ] }, "docs": "**Get POI by Name**

**Applies to**: S0 and S1 pricing tiers.


Points of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category." }, { "info": { "name": "Microsoft Azure Get Search Nearby Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/nearby/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "lat", "value": "", "type": "query", "description": "Latitude where results should be biased. E.g. 37.337." }, { "name": "lon", "value": "", "type": "query", "description": "Longitude where results should be biased. E.g. -121.89." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "countrySet", "value": "", "type": "query", "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000." }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "brandSet", "value": "", "type": "query", "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar" }, { "name": "connectorSet", "value": "", "type": "query", "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." } ] }, "docs": "**Nearby Search**

**Applies to**: S0 and S1 pricing tiers.


If you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter." }, { "info": { "name": "Microsoft Azure Get Search Poi Category Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/poi/category/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://docs.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories." }, { "name": "typeahead", "value": "", "type": "query", "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "countrySet", "value": "", "type": "query", "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries" }, { "name": "lat", "value": "", "type": "query", "description": "Latitude where results should be biased. E.g. 37.337" }, { "name": "lon", "value": "", "type": "query", "description": "Longitude where results should be biased. E.g. -121.89" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "topLeft", "value": "", "type": "query", "description": "Top left position of the bounding box. E.g. 37.553,-122.453" }, { "name": "btmRight", "value": "", "type": "query", "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "brandSet", "value": "", "type": "query", "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar" }, { "name": "connectorSet", "value": "", "type": "query", "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." }, { "name": "openingHours", "value": "", "type": "query", "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays" } ] }, "docs": "**Get POI by Category**

**Applies to**: S0 and S1 pricing tiers.


Points of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification." }, { "info": { "name": "Microsoft Azure Get Search Poi Category Tree Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/poi/category/tree/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details." } ] }, "docs": "**Get POI Category Tree**

**Applies to**: S0 and S1 pricing tiers.


POI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi)." }, { "info": { "name": "Microsoft Azure Get Search Address Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/address/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The address to search for (e.g., \"1 Microsoft way, Redmond, WA\"), must be properly URL encoded." }, { "name": "typeahead", "value": "", "type": "query", "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "countrySet", "value": "", "type": "query", "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries" }, { "name": "lat", "value": "", "type": "query", "description": "Latitude where results should be biased. E.g. 37.337" }, { "name": "lon", "value": "", "type": "query", "description": "Longitude where results should be biased. E.g. -121.89" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "topLeft", "value": "", "type": "query", "description": "Top left position of the bounding box. E.g. 37.553,-122.453" }, { "name": "btmRight", "value": "", "type": "query", "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." } ] }, "docs": "**Address Geocoding**

**Applies to**: S0 and S1 pricing tiers.


In 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 geocode 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 POIs will be returned. Note" }, { "info": { "name": "Microsoft Azure Get Search Address Reverse Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/address/reverse/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "returnSpeedLimit", "value": "", "type": "query", "description": "Boolean. To enable return of the posted speed limit" }, { "name": "heading", "value": "", "type": "query", "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "number", "value": "", "type": "query", "description": "If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number" }, { "name": "returnRoadUse", "value": "", "type": "query", "description": "Boolean. To enable return of the road use array for reverse geocodes at street level" }, { "name": "roadUse", "value": "", "type": "query", "description": "To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet" }, { "name": "allowFreeformNewline", "value": "", "type": "query", "description": "Format of newlines in the formatted address.\n\nIf true, the address will contain newlines.\nIf false, newlines will be converted to commas." }, { "name": "returnMatchType", "value": "", "type": "query", "description": "Include information on the type of match the geocoder achieved in the response." }, { "name": "entityType", "value": "", "type": "query", "description": "Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. The following parameters are ignored when entityType is set:\n\n* heading\n* number\n* returnRoadUse\n* returnSpeedLimit\n* roadUse\n* returnMatchType" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." } ] }, "docs": "**Reverse Geocode to an Address**

**Applies to**: S0 and S1 pricing tiers.


There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate." }, { "info": { "name": "Microsoft Azure Get Search Address Reverse Crossstreet Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/address/reverse/crossStreet/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "query", "value": "", "type": "query", "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "heading", "value": "", "type": "query", "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place" }, { "name": "radius", "value": "", "type": "query", "description": "The radius in meters to for the results to be constrained to the defined area" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." } ] }, "docs": "**Reverse Geocode to a Cross Street**

**Applies to**: S0 and S1 pricing tiers.


There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located.
This endpoint will return cross street information for a given coordinate." }, { "info": { "name": "Microsoft Azure Get Search Address Structured Format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search/address/structured/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "countryCode", "value": "", "type": "query", "description": "The 2 or 3 letter [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html) country code portion of an address. E.g. US." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "ofs", "value": "", "type": "query", "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900" }, { "name": "streetNumber", "value": "", "type": "query", "description": "The street number portion of an address" }, { "name": "streetName", "value": "", "type": "query", "description": "The street name portion of an address" }, { "name": "crossStreet", "value": "", "type": "query", "description": "The cross street name for the structured address" }, { "name": "municipality", "value": "", "type": "query", "description": "The municipality portion of an address" }, { "name": "municipalitySubdivision", "value": "", "type": "query", "description": "The municipality subdivision (sub/super city) for the structured address" }, { "name": "countryTertiarySubdivision", "value": "", "type": "query", "description": "The named area for the structured address" }, { "name": "countrySecondarySubdivision", "value": "", "type": "query", "description": "The county for the structured address" }, { "name": "countrySubdivision", "value": "", "type": "query", "description": "The country subdivision portion of an address" }, { "name": "postalCode", "value": "", "type": "query", "description": "The postal code portion of an address" }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." } ] }, "docs": "**Structured Address Geocoding**

**Applies to**: S0 and S1 pricing tiers.


Azure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No 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 " }, { "info": { "name": "Microsoft Azure Post Search Geometry Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/geometry/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "query", "value": "", "type": "query", "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\", \"pizza\"). Must be properly URL encoded." }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100" }, { "name": "language", "value": "", "type": "query", "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details." }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "extendedPostalCodesFor", "value": "", "type": "query", "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent." }, { "name": "idxSet", "value": "", "type": "query", "description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." }, { "name": "openingHours", "value": "", "type": "query", "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays" } ] }, "docs": "**Applies to**: S0 and S1 pricing tiers.

The Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type and the `Content-Type` header will be set to `application/json`. The geographical features to be searched can be modeled a" }, { "info": { "name": "Microsoft Azure Post Search Alongroute Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/alongRoute/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "categorySet", "value": "", "type": "query", "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) " }, { "name": "query", "value": "", "type": "query", "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\", \"pizza\"). Must be properly URL encoded." }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Value can be either _json_ or _xml_." }, { "name": "maxDetourTime", "value": "", "type": "query", "description": "Maximum detour time of the point of interest in seconds. Max value is 3600 seconds" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default value is 10. Max value is 20" }, { "name": "brandSet", "value": "", "type": "query", "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar" }, { "name": "connectorSet", "value": "", "type": "query", "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached" }, { "name": "view", "value": "", "type": "query", "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views." }, { "name": "openingHours", "value": "", "type": "query", "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays" } ] }, "docs": "**Applies to**: S0 and S1 pricing tiers.


The Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.To send the route-points you will use a `POST` request where the request body will contain the `route` object represented as a `GeoJSON LineString` type and the `Content-Type` header will be set to `application/json`. Each route-point in `route` is represented as a `" }, { "info": { "name": "Microsoft Azure Post Search Fuzzy Batch Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/fuzzy/batch/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." } ] }, "docs": "**Search Fuzzy Batch API**


**Applies to**: S1 pricing tier.



The Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.
### Submit Synchronous Batch Re" }, { "info": { "name": "Microsoft Azure Post Search Address Batch Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/address/batch/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." } ] }, "docs": "**Search Address Batch API**


**Applies to**: S1 pricing tier.



The Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.
### Submit Synchronous Batch Re" }, { "info": { "name": "Microsoft Azure Post Search Address Reverse Batch Format", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search/address/reverse/batch/:format", "headers": [ { "name": "x-ms-client-id", "value": "" } ], "params": [ { "name": "subscription-key", "value": "", "type": "query", "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication." }, { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API. Current version is 1.0" }, { "name": "format", "value": "", "type": "path", "description": "Desired format of the response. Only `json` format is supported." } ] }, "docs": "**Search Address Reverse Batch API**


**Applies to**: S1 pricing tier.



The Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.
" } ] } ], "bundled": true }