Skip to content

Update samples for Azure Maps Search: Get Geocoding Batch - REST API #40044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FarazGIS merged 5 commits into from
Feb 4, 2026
Merged

Update samples for Azure Maps Search: Get Geocoding Batch - REST API #40044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51d4c4a
https://msazure.visualstudio.com/One/_workitems/edit/36493310
stevemunk Jan 29, 2026
b5f5cc6
Updated sample request/response.
stevemunk Feb 3, 2026
31ba9cb
Apply prettier formatting
stevemunk Feb 3, 2026
5eacd00
Updated Geocoding Batch API samples.
stevemunk Feb 3, 2026
dfb38a5
Fixed variable name.
stevemunk Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 108 additions & 52 deletions ...on/maps/data-plane/Search/stable/2025-01-01/examples/ForwardGeocodingBatch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
"geocodingBatchRequestBody": {
"batchItems": [
{
"addressLine": "15127 NE 24th Street, Redmond, WA 98052",
"query": "15127 NE 24th Street, Redmond, WA 98052",
"top": 2,
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"query": "Pike Pl",
"addressLine": "Pike Pl",
"locality": "Seattle",
"top": 3
}
Expand All @@ -26,88 +26,144 @@
},
"batchItems": [
{
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.138677,
47.630351
]
},
"bbox": [
-122.1463188230466,
47.62648828242932,
-122.1310351769534,
47.634213717570674
],
"properties": {
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"addressLine": "15127 NE 24th St"
},
"geocodePoints": [
{
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
],
"geometry": {
"type": "Point",
"coordinates": [
-122.138669,
47.630359
-122.138677,
47.630351
]
},
}
},
{
"calculationMethod": "Rooftop",
"usageTypes": [
"Display",
"Route"
]
},
{
],
"geometry": {
"type": "Point",
"coordinates": [
-122.1387383,
47.630563
-122.1386748,
47.630218
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
}
]
},
],
"address": {
"addressLine": "15127 NE 24th St",
"streetName": "NE 24th St",
"streetNumber": "15127",
"postalCode": "98052",
"locality": "Redmond",
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"countryRegion": {
"name": "United States",
"ISO": "US"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
]
}
}
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.138669,
47.630359
-122.341979399674,
47.6095253501216
]
},
"bbox": [
-122.14631082421619,
47.62649628242932,
-122.1310271757838,
47.634221717570675
]
-122.34961817972945,
47.605662632550924,
-122.33434061961856,
47.61338806769228
],
"properties": {
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"calculationMethod": "Interpolation",
"usageTypes": [
"Display"
],
"geometry": {
"type": "Point",
"coordinates": [
-122.341979399674,
47.6095253501216
]
}
}
],
"address": {
"addressLine": "Pike Pl",
"streetName": "Pike Pl",
"postalCode": "98101",
"neighborhood": "Downtown Seattle",
"locality": "Seattle",
"formattedAddress": "Pike Pl, Seattle, WA 98101",
"countryRegion": {
"name": "United States",
"ISO": "US"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
]
}
}
}
]
},
{
"error": {
"code": "Conflicting Parameters",
"message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
}
}
]
}
Expand Down
4 changes: 2 additions & 2 deletions specification/maps/data-plane/Search/stable/2025-01-01/search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{

Check warning on line 1 in specification/maps/data-plane/Search/stable/2025-01-01/search.json

View workflow job for this annotation

GitHub Actions / TypeSpec Requirement 

WARNING: This PR uses OpenAPI / Swagger. All Azure services are required to convert to TypeSpec by March 30, 2026. PRs not using TypeSpec will be blocked after that date. Starting July 1, 2026, all SDKs will be generated from TypeSpec as the autorest toolchain is being retired. Please reach out to tspconversion@service.microsoft.com with any questions and see http://aka.ms/azsdk/typespec for more details on TypeSpec.
"swagger": "2.0",
"info": {
"title": "Azure Maps Search Service",
Expand Down Expand Up @@ -408,7 +408,7 @@
"/geocode:batch": {
"post": {
"summary": "Use to send a batch of queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request.",
"description": "\n\nThe `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request. \n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"addressLine\": \"One, Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n",
"description": "\n\nThe `Get Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to the [Geocoding](/rest/api/maps/search/get-geocoding) API in a single request. \n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/geocode:batch?api-version=2025-01-01\n```\n### POST Body for Batch Request\nTo send the _geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"query\": \"One Microsoft Way, Redmond, WA 98052\",\n \"top\": 2\n },\n {\n \"addressLine\": \"Pike Pl\",\n \"adminDistrict\": \"WA\",\n \"locality\": \"Seattle\",\n \"top\": 3\n }\n ]\n}\n```\n\nA _geocoding_ batchItem object can accept any of the supported _geocoding_ [URI parameters](/rest/api/maps/search/get-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n",
"operationId": "Search_GetGeocodingBatch",
"x-ms-examples": {
"A Geocoding Batch API call containing 2 Geocoding queries": {
Expand Down Expand Up @@ -570,7 +570,7 @@
"/reverseGeocode:batch": {
"post": {
"summary": "Use to send a batch of queries to the [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API in a single request.",
"description": "\n\nThe `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n",
"description": "\n\nThe `Get Reverse Geocoding Batch` API is an HTTP `POST` request that sends batches of up to **100** queries to [Reverse Geocoding](/rest/api/maps/search/get-reverse-geocoding) API using a single request.\n\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2025-01-01\n```\n### POST Body for Batch Request\nTo send the _reverse geocoding_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _reverse geocoding_ queries:\n\n\n```\n{\n \"batchItems\": [\n {\n \"coordinates\": [-122.128275, 47.639429],\n \"resultTypes\": [\"Address\", \"PopulatedPlace\"]\n },\n {\n \"coordinates\": [-122.341979399674, 47.6095253501216]\n }\n ]\n}\n```\n\nA _reverse geocoding_ batchItem object can accept any of the supported _reverse geocoding_ [URI parameters](/rest/api/maps/search/get-reverse-geocoding#uri-parameters).\n\n\nThe batch should contain at least **1** query.\n\n\n### Batch Response Model\nThe batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:\n\n - [`GeocodingResponse`](/rest/api/maps/search/get-reverse-geocoding#geocodingresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\n",
"operationId": "Search_GetReverseGeocodingBatch",
"x-ms-examples": {
"A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries": {
Expand Down