{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Geocode API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Geocode", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Geocode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/geocode", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API." }, { "name": "top", "value": "", "type": "query", "description": "Maximum number of responses that will be returned. Default: 5, minimum: 1 and maximum: 20." }, { "name": "query", "value": "", "type": "query", "description": "A string that contains information about a location, such as an address or landmark name." }, { "name": "addressLine", "value": "", "type": "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\n**If query is given, should not use this parameter.**" }, { "name": "countryRegionSet", "value": "", "type": "query", "description": "Comma separated string of country or region codes(ISO 3166-1 Alpha-2), e.g. FR,ES. This will limit the search to the specified countries. Only the first country code will be used for the Geocoder.\n\n**If query is given, should not use this parameter.**" }, { "name": "bbox", "value": "", "type": "query", "description": "A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by latitude and longitude 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" }, { "name": "view", "value": "", "type": "query", "description": "A string that 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." }, { "name": "location", "value": "", "type": "query", "description": "A point on the earth specified as a latitude and longitude. 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: &location=lon,lat" }, { "name": "adminDistrict", "value": "", "type": "query", "description": "The country subdivision portion of an address, such as WA.\n\n**If query is given, should not use this parameter.**" }, { "name": "adminDistrict2", "value": "", "type": "query", "description": "The county for the structured address, such as King.\n\n**If query is given, should not use this parameter.**" }, { "name": "adminDistrict3", "value": "", "type": "query", "description": "The named area for the structured address.\n\n**If query is given, should not use this parameter.**" }, { "name": "locality", "value": "", "type": "query", "description": "The locality portion of an address, such as Seattle.\n\n**If query is given, should not use this parameter.**" }, { "name": "postalCode", "value": "", "type": "query", "description": "The postal code portion of an address.\n\n**If query is given, should not use this parameter.**" }, { "name": "strictMatch", "value": "", "type": "query", "description": "Restrict the geocoding result to the country or region that is specified in the countryRegionSet field and the state, province or territory specified in the adminDistrict field.\n\n**If query is given, should not use this parameter.**" } ] }, "docs": "**Geocoding**

**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

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 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 POIs" }, { "info": { "name": "Microsoft Azure Post Geocode Batch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/geocode/batch", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "Version number of Azure Maps API." } ] }, "docs": "**Geocoding Batch API**


**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).



The Geocoding Batch API sends batches of queries to [Geocoding API](https://docs.microsoft.com/rest/api/maps/search-v2/get-geocoding) using just a single API call. The API allows caller to batch up to **100** queries.
>[!Important]
>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/support/leg" } ] } ], "bundled": true }