Skip to content

Commit 172fa47

Browse files
committed
Updated to use bruno instead of postman.
1 parent ff12ca5 commit 172fa47

File tree

6 files changed

+36
-35
lines changed

6 files changed

+36
-35
lines changed

articles/azure-maps/glossary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ The following list describes common words used with the Azure Maps services.
151151

152152
## G
153153

154+
<a name="geobias"></a> **Geobias**: A geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.
155+
154156
<a name="geocode"></a> **Geocode**: An address or location that has been converted into a coordinate that can be used to display that location on a map.
155157

156158
<a name="geocoding"></a> **Geocoding**: Or _forward geocoding_, is the process of converting address of location data into coordinates.

articles/azure-maps/how-to-search-for-address.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ This article uses the [bruno] application, but you can choose a different API de
3636

3737
The example in this section uses [Get Search Address] to convert an address into latitude and longitude coordinates. This process is also called *geocoding*. In addition to returning the coordinates, the response also returns detailed address properties such as street, postal code, municipality, and country/region information.
3838

39-
>[!TIP]
40-
>If you have a set of addresses to geocode, you can use [Post Search Address Batch] to send a batch of queries in a single request.
39+
> [!TIP]
40+
> If you have a set of addresses to geocode, you can use [Post Search Address Batch] to send a batch of queries in a single request.
4141
4242
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
4343

@@ -47,23 +47,23 @@ The example in this section uses [Get Search Address] to convert an address into
4747
https://atlas.microsoft.com/search/address/json?&subscription-key={Your-Azure-Maps-Subscription-key}&api-version=1.0&language=en-US&query=400 Broad St, Seattle, WA 98109
4848
```
4949
50-
This request searches for a specific address: `400 Broad St, Seattle, WA 98109`.
51-
5250
1. Select the **Create** button.
5351
5452
1. Select the run button.
5553
56-
1. Next, search an address that has more than one possible location. In the **Params** section, change the `query` key to `400 Broad, Seattle`. Select the blue **Send** button.
54+
This request searches for a specific address: `400 Broad St, Seattle, WA 98109`. Next, search an address that has more than one possible location.
55+
56+
1. In the **Params** section, change the `query` key to `400 Broad, Seattle`, then select the run button.
5757
5858
:::image type="content" source="./media/how-to-search-for-address/search-address.png" alt-text="Search for address":::
5959
60-
1. Next, try setting the `query` key to `400 Broa`.
60+
1. Next, try setting the `query` key to `400 Broa`, then select the run button.
6161
62-
1. Select the **Send** button. The response includes results from multiple countries/regions. To geobias results to the relevant area for your users, always add as many location details as possible to the request.
62+
The response includes results from multiple countries/regions. To [geobias] results to the relevant area for your users, always add as many location details as possible to the request.
6363
6464
## Fuzzy Search
6565
66-
[Fuzzy Search] supports standard single line and free-form searches. We recommend that you use the Azure Maps Search Fuzzy API when you don't know your user input type for a search request. The query input can be a full or partial address. It can also be a Point of Interest (POI) token, like a name of POI, POI category or name of brand. Furthermore, to improve the relevance of your search results, constrain the query results using a coordinate location and radius, or by defining a bounding box.
66+
[Fuzzy Search] supports standard single line and free-form searches. We recommend that you use the Azure Maps Search Fuzzy API when you don't know your user input type for a search request. The query input can be a full or partial address. It can also be a Point of Interest (POI) token, like a name of POI, POI category or name of brand. Furthermore, to improve the relevance of your search results, constrain the query results using a coordinate location and radius, or by defining a bounding box.
6767
6868
> [!TIP]
6969
> Most Search queries default to `maxFuzzyLevel=1` to improve performance and reduce unusual results. Adjust fuzziness levels by using the `maxFuzzyLevel` or `minFuzzyLevel` parameters. For more information on `maxFuzzyLevel` and a complete list of all optional parameters, see [Fuzzy Search URI Parameters].
@@ -77,28 +77,28 @@ The example in this section uses `Fuzzy Search` to search the entire world for *
7777
7878
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
7979
80-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key.
80+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
8181
8282
```http
83-
https://atlas.microsoft.com/search/fuzzy/json?&api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=pizza
83+
https://atlas.microsoft.com/search/fuzzy/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=pizza
8484
```
8585
8686
> [!NOTE]
8787
> The _json_ attribute in the URL path determines the response format. This article uses json for ease of use and readability. To find other supported response formats, see the `format` parameter definition in the [URI Parameter reference] documentation.
8888
89-
3. Select **Send** and review the response body.
89+
1. Select the run button, then review the response body.
9090
91-
The ambiguous query string for "pizza" returned 10 [point of interest result] (POI) in both the "pizza" and "restaurant" categories. Each result includes details such as street address, latitude and longitude values, view port, and entry points for the location. The results are now varied for this query, and aren't tied to any reference location.
91+
The ambiguous query string for "pizza" returned 10 [point of interest] (POI) results in both the "pizza" and "restaurant" categories. Each result includes details such as street address, latitude and longitude values, view port, and entry points for the location. The results are now varied for this query, and aren't tied to any reference location.
9292
93-
In the next step, you'll use the `countrySet` parameter to specify only the countries/regions for which your application needs coverage. For a complete list of supported countries/regions, see [Search Coverage].
93+
In the next step, you'll use the `countrySet` parameter to specify only the countries/regions for which your application needs coverage. For a complete list of supported countries/regions, see [Azure Maps geocoding coverage].
9494
95-
4. The default behavior is to search the entire world, potentially returning unnecessary results. Next, search for pizza only in the United States. Add the `countrySet` key to the **Params** section, and set its value to `US`. Setting the `countrySet` key to `US` bounds the results to the United States.
95+
1. The default behavior is to search the entire world, potentially returning unnecessary results. Next, search for pizza only in the United States. Add the `countrySet` key to the **Params** section, and set its value to `US`. Setting the `countrySet` key to `US` bounds the results to the United States.
9696
9797
:::image type="content" source="./media/how-to-search-for-address/search-fuzzy-country.png" alt-text="Search for pizza in the United States":::
9898
9999
The results are now bounded by the country code and the query returns pizza restaurants in the United States.
100100
101-
5. To get an even more targeted search, you can search over the scope of a lat/lon coordinate pair. The following example uses the lat/lon coordinates of the Seattle Space Needle. Since we only want to return results within a 400-meters radius, we add the `radius` parameter. Also, we add the `limit` parameter to limit the results to the five closest pizza places.
101+
1. To get an even more targeted search, you can search over the scope of a lat/lon coordinate pair. The following example uses the lat/lon coordinates of the Seattle Space Needle. Since we only want to return results within a 400-meters radius, we add the `radius` parameter. Also, we add the `limit` parameter to limit the results to the five closest pizza places.
102102
103103
In the **Params** section, add the following key/value pairs:
104104
@@ -109,14 +109,14 @@ The example in this section uses `Fuzzy Search` to search the entire world for *
109109
| radius | 400 |
110110
| limit | 5 |
111111
112-
6. Select **Send**. The response includes results for pizza restaurants near the Seattle Space Needle.
112+
1. Select run. The response includes results for pizza restaurants near the Seattle Space Needle.
113113
114114
## Search for a street address using Reverse Address Search
115115
116116
[Get Search Address Reverse] translates coordinates into human readable street addresses. This API is often used for applications that consume GPS feeds and want to discover addresses at specific coordinate points.
117117
118118
> [!IMPORTANT]
119-
> To geobias results to the relevant area for your users, always add as many location details as possible. For more information, see [Best Practices for Search].
119+
> To [geobias] results to the relevant area for your users, always add as many location details as possible. For more information, see [Best Practices for Search].
120120
121121
> [!TIP]
122122
> If you have a set of coordinate locations to reverse geocode, you can use [Post Search Address Reverse Batch] to send a batch of queries in a single request.
@@ -125,32 +125,32 @@ This example demonstrates making reverse searches using a few of the optional pa
125125
126126
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
127127
128-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key. The request should look like the following URL:
128+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
129129
130130
```http
131-
https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=47.591180,-122.332700&number=1
131+
https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=47.591180,-122.332700
132132
```
133133
134-
3. Select **Send**, and review the response body. You should see one query result. The response includes key address information about Safeco Field.
134+
1. Select the run button, and review the response body. You should see one query result. The response includes key address information about Safeco Field.
135135
136-
4. Next, add the following key/value pairs to the **Params** section:
136+
1. Next, add the following key/value pairs to the **Params** section:
137137
138-
| Key | Value | Returns
139-
|-----|------------|------|
140-
| number | 1 |The response may include the side of the street (Left/Right) and also an offset position for the number.|
138+
| Key | Value | Returns |
139+
|-----|-------|---------|
140+
| number | 1 |The response can include the side of the street (Left/Right) and also an offset position for the number.|
141141
| returnSpeedLimit | true | Returns the speed limit at the address.|
142142
| returnRoadUse | true | Returns road use types at the address. For all possible road use types, see [Road Use Types].|
143-
| returnMatchType | true| Returns the type of match. For all possible values, see [Reverse Address Search Results].
143+
| returnMatchType | true| Returns the type of match. For all possible values, see [Reverse Address Search Results]. |
144144
145145
:::image type="content" source="./media/how-to-search-for-address/search-reverse.png" alt-text="Search reverse.":::
146146
147-
5. Select **Send**, and review the response body.
147+
1. Select the run button, and review the response body.
148148
149-
6. Next, we add the `entityType` key, and set its value to `Municipality`. The `entityType` key overrides the `returnMatchType` key in the previous step. `returnSpeedLimit` and `returnRoadUse` also need removed since you're requesting information about the municipality. For all possible entity types, see [Entity Types].
149+
1. Next, add the `entityType` key, and set its value to `Municipality`. The `entityType` key overrides the `returnMatchType` key in the previous step. `returnSpeedLimit` and `returnRoadUse` also need removed since you're requesting information about the municipality. For all possible entity types, see [Entity Types].
150150
151151
:::image type="content" source="./media/how-to-search-for-address/search-reverse-entity-type.png" alt-text="Search reverse entityType.":::
152152
153-
7. Select **Send**. Compare the results to the results returned in step 5. Because the requested entity type is now `municipality`, the response doesn't include street address information. Also, the returned `geometryId` can be used to request boundary polygon through Azure Maps Get [Search Polygon API].
153+
1. Select the run button. Compare the results to the results returned in step 5. Because the requested entity type is now `municipality`, the response doesn't include street address information. Also, the returned `geometryId` can be used to request boundary polygon through Azure Maps Get [Search Polygon API].
154154
155155
> [!TIP]
156156
> For more information on these as well as other parameters, see [Reverse Search Parameters].
@@ -161,15 +161,13 @@ This example demonstrates how to search for a cross street based on the coordina
161161
162162
1. Open the bruno app, select **NEW REQUEST** to create the request. In the **NEW REQUEST** window, set **Type** to **HTTP**. Enter a **Name** for the request.
163163
164-
2. Select the **GET** HTTP method in the builder tab and enter the following URL. For this request, and other requests mentioned in this article, replace `{Your-Azure-Maps-Subscription-key}` with your Azure Maps subscription key. The request should look like the following URL:
164+
1. Select the **GET** HTTP method in the **URL** drop-down list, then enter the following URL:
165165
166166
```http
167-
https://atlas.microsoft.com/search/address/reverse/crossstreet/json?&api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=47.591180,-122.332700
167+
https://atlas.microsoft.com/search/address/reverse/crossstreet/json?api-version=1.0&subscription-key={Your-Azure-Maps-Subscription-key}&language=en-US&query=47.591180,-122.332700
168168
```
169169
170-
:::image type="content" source="./media/how-to-search-for-address/search-address-cross.png" alt-text="Search cross street.":::
171-
172-
3. Select **Send**, and review the response body. Notice that the response contains a `crossStreet` value of `South Atlantic Street`.
170+
1. Select the run button, and review the response body. Notice that the response contains a `crossStreet` value of `South Atlantic Street`.
173171
174172
## Next steps
175173
@@ -186,9 +184,10 @@ This example demonstrates how to search for a cross street based on the coordina
186184
[Entity Types]: /rest/api/maps/search/getsearchaddressreverse?view=rest-maps-1.0&preserve-view=true#entitytype
187185
[Fuzzy Search URI Parameters]: /rest/api/maps/search/getsearchfuzzy?view=rest-maps-1.0&preserve-view=true#uri-parameters
188186
[Fuzzy Search]: /rest/api/maps/search/getsearchfuzzy?view=rest-maps-1.0&preserve-view=true
187+
[geobias]: glossary.md#geobias
189188
[Get Search Address Reverse]: /rest/api/maps/search/getsearchaddressreverse?view=rest-maps-1.0&preserve-view=true
190189
[Get Search Address]: /rest/api/maps/search/getsearchaddress?view=rest-maps-1.0&preserve-view=true
191-
[point of interest result]: /rest/api/maps/search/getsearchpoi?view=rest-maps-1.0&preserve-view=true#searchpoiresponse
190+
[point of interest]: /rest/api/maps/search/getsearchpoi?view=rest-maps-1.0&preserve-view=true#searchpoiresponse
192191
[Post Search Address Batch]: /rest/api/maps/search/postsearchaddressbatch
193192
[Post Search Address Reverse Batch]: /rest/api/maps/search/postsearchaddressreversebatch?view=rest-maps-1.0&preserve-view=true
194193
[bruno]: https://www.usebruno.com/
@@ -199,7 +198,7 @@ This example demonstrates how to search for a cross street based on the coordina
199198
[Route]: /rest/api/maps/route
200199
[Search Address Reverse Cross Street]: /rest/api/maps/search/getsearchaddressreversecrossstreet?view=rest-maps-1.0&preserve-view=true
201200
[Search Address]: /rest/api/maps/search/getsearchaddress?view=rest-maps-1.0&preserve-view=true
202-
[Search Coverage]: geocoding-coverage.md
201+
[Azure Maps geocoding coverage]: geocoding-coverage.md
203202
[Search Polygon API]: /rest/api/maps/search/getsearchpolygon?view=rest-maps-1.0&preserve-view=true
204203
[Search]: /rest/api/maps/search?view=rest-maps-1.0&preserve-view=true
205204
[subscription key]: quick-demo-map-app.md#get-the-subscription-key-for-your-account
69.4 KB
Loading
68.6 KB
Loading
164 KB
Loading
142 KB
Loading

0 commit comments

Comments
 (0)