Microsoft Azure Search API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Search API
schemes:
- https
tags:
- name: Search
paths:
  /search/autocomplete:
    post:
      operationId: microsoftAzureDiscoveryAutocomplete
      description: Get auto complete options.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/AutoCompleteOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AutoCompleteResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/AtlasErrorResponse'
      x-ms-examples:
        Discovery_AutoComplete:
          $ref: ./examples/Discovery_AutoComplete.json
      summary: Microsoft Azure Post Search Autocomplete
      tags:
      - Search
  /search/query:
    post:
      operationId: microsoftAzureDiscoveryQuery
      description: Get data using search.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/QueryOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/QueryResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/AtlasErrorResponse'
      x-ms-examples:
        Discovery_Query:
          $ref: ./examples/Discovery_Query.json
        Discovery_Query_And:
          $ref: ./examples/Discovery_Query_And.json
        Discovery_Query_AndOrNested:
          $ref: ./examples/Discovery_Query_AndOrNested.json
        Discovery_Query_AssetType:
          $ref: ./examples/Discovery_Query_AssetType.json
        Discovery_Query_Attribute:
          $ref: ./examples/Discovery_Query_Attribute.json
        Discovery_Query_BusinessMetadataAttribute:
          $ref: ./examples/Discovery_Query_BusinessMetadataAttribute.json
        Discovery_Query_Classification:
          $ref: ./examples/Discovery_Query_Classification.json
        Discovery_Query_Collection:
          $ref: ./examples/Discovery_Query_Collection.json
        Discovery_Query_Facet:
          $ref: ./examples/Discovery_Query_Facet.json
        Discovery_Query_FileExtension:
          $ref: ./examples/Discovery_Query_FileExtension.json
        Discovery_Query_GlossaryTerm:
          $ref: ./examples/Discovery_Query_GlossaryTerm.json
        Discovery_Query_Id:
          $ref: ./examples/Discovery_Query_Id.json
        Discovery_Query_Not:
          $ref: ./examples/Discovery_Query_Not.json
        Discovery_Query_ObjectType:
          $ref: ./examples/Discovery_Query_ObjectType.json
        Discovery_Query_PaginationContinuationPage:
          $ref: ./examples/Discovery_Query_PaginationContinuationPage.json
        Discovery_Query_PaginationFirstPage:
          $ref: ./examples/Discovery_Query_PaginationFirstPage.json
        Discovery_Query_PaginationLastPage:
          $ref: ./examples/Discovery_Query_PaginationLastPage.json
        Discovery_Query_SystemTime:
          $ref: ./examples/Discovery_Query_SystemTime.json
        Discovery_Query_Taxonomy:
          $ref: ./examples/Discovery_Query_Taxonomy.json
        Discovery_Query_TermAssignment:
          $ref: ./examples/Discovery_Query_TermAssignment.json
        Discovery_Query_Type:
          $ref: ./examples/Discovery_Query_Type.json
      summary: Microsoft Azure Post Search Query
      tags:
      - Search
  /search/suggest:
    post:
      operationId: microsoftAzureDiscoverySuggest
      description: Get search suggestions by query criteria.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/SuggestOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/SuggestResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/AtlasErrorResponse'
      x-ms-examples:
        Discovery_Suggest:
          $ref: ./examples/Discovery_Suggest.json
      summary: Microsoft Azure Post Search Suggest
      tags:
      - Search
  /search/polygon/{format}:
    get:
      x-publish: true
      description: '**Get Polygon**<br><br><br>**Applies to**: S1 pricing tier.<br><br><br>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.<br><br>Please note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client  should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is  not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a  few minutes of the request to the Online Search method that provided the ID. The service allows for batch  requests up to 20 identifiers.'
      operationId: microsoftAzureSearchGetsearchpolygon
      x-ms-examples:
        Get the Geometry using the geometry id returned by the previous Search:
          $ref: ./examples/GetSearchPolygon.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: geometries
        in: query
        description: Comma separated list of geometry UUIDs, previously retrieved from an Online Search request.
        required: true
        type: string
        x-ms-parameter-location: method
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchPolygonResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      produces:
      - application/json
      summary: Microsoft Azure Get Search Polygon Format
      tags:
      - Search
  /search/fuzzy/{format}:
    get:
      x-publish: true
      description: '<br>**Free Form Search**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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 generally without any geo biasing anchor point.We strongly advise you to use the ''countrySet'' parameter to specify only the countries for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results. E.g.: `countrySet`=US,FR Please see [Search Coverage](https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries.Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.'
      operationId: microsoftAzureSearchGetsearchfuzzy
      x-ms-examples:
        Search City Seattle:
          $ref: ./examples/GetSearchFuzzy.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: 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.
        required: true
        type: string
        x-ms-parameter-location: method
      - $ref: '#/parameters/Typeahead'
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - $ref: '#/parameters/CategorySet'
      - $ref: '#/parameters/CountrySet'
      - $ref: '#/parameters/OptionalBiasLat'
      - $ref: '#/parameters/OptionalBiasLon'
      - $ref: '#/parameters/Radius'
      - $ref: '#/parameters/BoundingBoxTopLeft'
      - $ref: '#/parameters/BoundingBoxBottomRight'
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/ExtendedPostalCodesFor'
      - name: minFuzzyLevel
        in: query
        description: 'Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4


          * Level 1 has no spell checking.


          * Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."


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


          * Level 4 doesn’t add any more spell checking functions.




          The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.'
        required: false
        type: integer
        default: 1
        minimum: 1
        maximum: 4
      - name: maxFuzzyLevel
        in: query
        description: 'Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4


          * Level 1 has no spell checking.


          * Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant."


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


          * Level 4 doesn’t add any more spell checking functions.




          The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.'
        required: false
        type: integer
        default: 2
        minimum: 1
        maximum: 4
      - $ref: '#/parameters/SearchIndexSet'
      - $ref: '#/parameters/BrandSet'
      - $ref: '#/parameters/ConnectorSet'
      - $ref: '#/parameters/View'
      - $ref: '#/parameters/OpeningHours'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchFuzzyResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Fuzzy Format
      tags:
      - Search
  /search/poi/{format}:
    get:
      x-publish: true
      description: '**Get POI by Name**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.'
      operationId: microsoftAzureSearchGetsearchpoi
      x-ms-examples:
        Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results:
          $ref: ./examples/GetSearchPOI.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: query
        description: The POI name to search for (e.g., "statue of liberty", "starbucks"), must be properly URL encoded.
        required: true
        type: string
        x-ms-parameter-location: method
      - $ref: '#/parameters/Typeahead'
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - $ref: '#/parameters/CategorySet'
      - $ref: '#/parameters/CountrySet'
      - $ref: '#/parameters/OptionalBiasLat'
      - $ref: '#/parameters/OptionalBiasLon'
      - $ref: '#/parameters/Radius'
      - $ref: '#/parameters/BoundingBoxTopLeft'
      - $ref: '#/parameters/BoundingBoxBottomRight'
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/ExtendedPostalCodesForPoi'
      - $ref: '#/parameters/BrandSet'
      - $ref: '#/parameters/ConnectorSet'
      - $ref: '#/parameters/View'
      - $ref: '#/parameters/OpeningHours'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchPoiResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Poi Format
      tags:
      - Search
  /search/nearby/{format}:
    get:
      x-publish: true
      description: '**Nearby Search**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.'
      operationId: microsoftAzureSearchGetsearchnearby
      x-ms-examples:
        Search for any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results:
          $ref: ./examples/GetSearchNearby.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - $ref: '#/parameters/RequiredBiasLat'
      - $ref: '#/parameters/RequiredBiasLon'
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - $ref: '#/parameters/CategorySet'
      - $ref: '#/parameters/CountrySet'
      - name: radius
        in: 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.
        required: false
        type: number
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/ExtendedPostalCodesFor'
      - $ref: '#/parameters/BrandSet'
      - $ref: '#/parameters/ConnectorSet'
      - $ref: '#/parameters/View'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchNearbyResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Nearby Format
      tags:
      - Search
  /search/poi/category/{format}:
    get:
      x-publish: true
      description: '**Get POI by Category**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.'
      operationId: microsoftAzureSearchGetsearchpoicategory
      x-ms-examples:
        Search for atm's within 2 miles of Times Square NY and return the top 3 results:
          $ref: ./examples/GetSearchPOICategory.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: 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.
        required: true
        type: string
        x-ms-parameter-location: method
      - $ref: '#/parameters/Typeahead'
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - $ref: '#/parameters/CategorySet'
      - $ref: '#/parameters/CountrySet'
      - $ref: '#/parameters/OptionalBiasLat'
      - $ref: '#/parameters/OptionalBiasLon'
      - $ref: '#/parameters/Radius'
      - $ref: '#/parameters/BoundingBoxTopLeft'
      - $ref: '#/parameters/BoundingBoxBottomRight'
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/ExtendedPostalCodesFor'
      - $ref: '#/parameters/BrandSet'
      - $ref: '#/parameters/ConnectorSet'
      - $ref: '#/parameters/View'
      - $ref: '#/parameters/OpeningHours'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchPoiCategoryResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Poi Category Format
      tags:
      - Search
  /search/poi/category/tree/{format}:
    get:
      x-publish: true
      description: '**Get POI Category Tree**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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).'
      operationId: microsoftAzureSearchGetsearchpoicategorytreepreview
      x-ms-examples:
        Get the POI Category Tree (only partial response shown below):
          $ref: ./examples/GetPOICategoryTree.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: language
        in: 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).


          Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.'
        required: false
        type: string
        x-ms-parameter-location: method
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PoiCategoryResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Poi Category Tree Format
      tags:
      - Search
  /search/address/{format}:
    get:
      x-publish: true
      description: '**Address Geocoding**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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 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, states etc.'
      operationId: microsoftAzureSearchGetsearchaddress
      x-ms-examples:
        Search detail address 15127 NE 24th Street, Redmond, WA 98052:
          $ref: ./examples/GetSearchAddress.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - name: query
        in: query
        description: The address to search for (e.g., "1 Microsoft way, Redmond, WA"), must be properly URL encoded.
        required: true
        type: string
        x-ms-parameter-location: method
      - $ref: '#/parameters/Typeahead'
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - $ref: '#/parameters/CountrySet'
      - $ref: '#/parameters/OptionalBiasLat'
      - $ref: '#/parameters/OptionalBiasLon'
      - $ref: '#/parameters/Radius'
      - $ref: '#/parameters/BoundingBoxTopLeft'
      - $ref: '#/parameters/BoundingBoxBottomRight'
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/ExtendedPostalCodesFor'
      - $ref: '#/parameters/View'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchAddressResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Address Format
      tags:
      - Search
  /search/address/reverse/{format}:
    get:
      x-publish: true
      description: '**Reverse Geocode to an Address**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.'
      operationId: microsoftAzureSearchGetsearchaddressreverse
      x-ms-examples:
        GetSearchAddressReverse:
          $ref: ./examples/GetSearchAddressReverse.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - $ref: '#/parameters/Position'
      - $ref: '#/parameters/Language'
      - name: returnSpeedLimit
        in: query
        description: Boolean. To enable return of the posted speed limit
        required: false
        type: boolean
        default: false
      - name: heading
        in: 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
        required: false
        type: number
        minimum: -360
        maximum: 360
      - $ref: '#/parameters/Radius'
      - name: number
        in: 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
        required: false
        type: string
      - name: returnRoadUse
        in: query
        description: Boolean. To enable return of the road use array for reverse geocodes at street level
        required: false
        type: boolean
        default: false
      - name: roadUse
        in: 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
        required: false
        type: string
      - name: allowFreeformNewline
        in: query
        description: 'Format of newlines in the formatted address.


          If true, the address will contain newlines.

          If false, newlines will be converted to commas.'
        required: false
        type: boolean
      - name: returnMatchType
        in: query
        description: Include information on the type of match the geocoder achieved in the response.
        required: false
        type: boolean
      - name: entityType
        in: 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:


          * heading

          * number

          * returnRoadUse

          * returnSpeedLimit

          * roadUse

          * returnMatchType'
        required: false
        type: string
        enum:
        - Country
        - CountrySubdivision
        - CountrySecondarySubdivision
        - CountryTertiarySubdivision
        - Municipality
        - MunicipalitySubdivision
        - Neighbourhood
        - PostalCodeArea
        x-ms-enum:
          name: EntityType
          modelAsString: true
          values:
          - value: Country
            description: Country name
          - value: CountrySubdivision
            description: State or Province
          - value: CountrySecondarySubdivision
            description: County
          - value: CountryTertiarySubdivision
            description: Named Area
          - value: Municipality
            description: City / Town
          - value: MunicipalitySubdivision
            description: Sub / Super City
          - value: Neighbourhood
            description: Neighbourhood
          - value: PostalCodeArea
            description: Postal Code / Zip Code
        x-ms-parameter-location: method
      - $ref: '#/parameters/View'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchAddressReverseResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Address Reverse Format
      tags:
      - Search
  /search/address/reverse/crossStreet/{format}:
    get:
      x-publish: true
      description: '**Reverse Geocode to a Cross Street**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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.<br>This endpoint will return cross street information  for a given coordinate.'
      operationId: microsoftAzureSearchGetsearchaddressreversecrossstreet
      x-ms-examples:
        GetSearchAddressReverseCrossStreet:
          $ref: ./examples/GetSearchAddressReverseCrossStreet.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - $ref: '#/parameters/Position'
      - $ref: '#/parameters/LimitSearch'
      - name: heading
        in: 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
        required: false
        type: number
        minimum: -360
        maximum: 360
      - $ref: '#/parameters/Radius'
      - $ref: '#/parameters/Language'
      - $ref: '#/parameters/View'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SearchAddressReverseCrossStreetResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Search Address Reverse Crossstreet Format
      tags:
      - Search
  /search/address/structured/{format}:
    get:
      x-publish: true
      description: '**Structured Address Geocoding**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>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 as city centers,  counties, states etc.'
      operationId: microsoftAzureSearchGetsearchaddressstructured
      x-ms-examples:
        GetSearchAddressStructured:
          $ref: ./examples/GetSearchAddressStructured.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/TextFormat'
      - $ref: '#/parameters/Language'
      - name: countryCode
        in: 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.
        required: true
        default: US
        type: string
      - $ref: '#/parameters/LimitSearch'
      - $ref: '#/parameters/Offset'
      - name: streetNumber
        in: query
        description: The street number portion of an address
        required: false
        type: string
      - name: streetName
        in: query
        description: The street name portion of an address
        required: false
        type: string
      - name: crossStreet
        in: query
        description: The cross street name for the structured address
        required: false
        type: string
      - name: municipality
        in: query
        description: The municipality portion of an address
        required: false
        type: string
      - name: municipalitySubdivision
        in: query
        description: The municipality subdivision (sub/super city) for the structured address
        required: false
        type: string
      - name: countryTertiarySubdivision
        in: query
        description: The named area for the structured address
        required: false
        type: string
      - name: countrySecondarySubdivision
        in: query
        description: The county for the structured address
        required: false
        type: string
      - name: countrySubdivision
        in: query
        description: The country subdivision portion of an address
        required: false
        type: string
      - name: postalCode
        in: query
        description: The postal code portion of an address
        required: false
        type: string
      - $ref: '#/parameters/ExtendedPostalCodesFor'
      - $ref: '#/parameters/View'
      responses:
        '200':
          description: OK
          s

# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-search-api-openapi.yml