Search - Get Search Address Reverse Batch

Layanan:: Maps

Versi API:: 1.0

Gunakan untuk mengirim batch kueri ke Search Address Reverse API dalam satu permintaan asinkron.

API Get Search Address Reverse Batch adalah permintaan GET HTTP yang mengirim batch kueri ke Search Address Reverse API dalam satu panggilan API asinkron. Anda dapat memanggil API Get Search Address Reverse Batch untuk berjalan secara asinkron (asinkron) atau sinkron (sinkronisasi). API asinkron memungkinkan pemanggil untuk mengumpulkan hingga 10.000 kueri dan menyinkronkan API hingga 100 kueri.

Kirim Permintaan Batch Sinkron

API Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Batch Asinkron

API Asinkron sesuai untuk memproses volume besar permintaan pencarian yang relatif kompleks

Ini memungkinkan pengambilan hasil dalam panggilan terpisah (beberapa unduhan dimungkinkan).
API asinkron dioptimalkan untuk keandalan dan tidak diharapkan mengalami batas waktu.
Jumlah item batch dibatasi hingga 10.000 untuk API ini.

Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Respons asinkron disimpan selama 14 hari. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.

Harap dicatat bahwa permintaan batch asinkron adalah operasi yang berjalan lama. Berikut adalah urutan operasi yang khas:

Klien mengirimkan permintaan POST Batch Terbalik Alamat Pencarian ke Azure Maps.

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

Server akan merespons dengan salah satu hal berikut:

HTTP 202 Accepted - Permintaan batch telah diterima.

HTTP Error - Ada kesalahan saat memproses permintaan Batch Anda. Ini bisa berupa 400 Bad Request atau kode status Error lainnya.
Jika permintaan batch berhasil diterima, header Location dalam respons berisi URL untuk mengunduh hasil permintaan batch. URI status ini terlihat seperti berikut:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Klien mengeluarkan permintaan GET pada URL unduhan diperoleh di Langkah 3 untuk mengunduh hasil batch.

Isi POST untuk Permintaan Batch

Untuk mengirim kueri alamat pencarian, Anda akan menggunakan permintaan POST di mana isi permintaan akan berisi array batchItems dalam format json dan header Content-Type akan diatur ke application/json. Berikut adalah contoh isi permintaan yang berisi 5 kueri alamat pencarian:

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Kueri alamat pencarian dalam batch hanyalah URL parsial tanpa protokol, URL dasar, jalur, versi api, dan kunci langganan. Ini dapat menerima salah satu parameter URI alamat pencarian yang didukung. Nilai string dalam kueri alamat pencarian terbalik harus diloloskan dengan benar (misalnya karakter " harus diloloskan dengan \ ) dan juga harus dikodekan DENGAN URL dengan benar.

API asinkron memungkinkan pemanggil untuk mengumpulkan hingga 10.000 kueri dan menyinkronkan API hingga 100 kueri, dan batch harus berisi setidaknya 1 kueri.

Unduh Hasil Batch Asinkron

Untuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan GET ke titik akhir unduhan batch. URL unduhan ini dapat diperoleh dari header permintaan batch yang berhasil dan terlihat seperti berikut ini:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:

Klien mengirim permintaan GET menggunakan URL unduhan .
Server akan merespons dengan salah satu hal berikut:

HTTP 202 Accepted - Permintaan batch diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan batch berhasil diproses. Isi respons berisi semua hasil batch.

Model Respons Batch

Konten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen summary yang menunjukkan totalRequests yang merupakan bagian dari permintaan batch asli dan successfulRequestsyaitu kueri yang berhasil dijalankan. Respons batch juga menyertakan array batchItems yang berisi respons untuk setiap kueri dalam permintaan batch. batchItems akan berisi hasil dalam urutan yang sama persis dengan kueri asli yang dikirim dalam permintaan batch. Setiap item dalam batchItems berisi bidang statusCode dan response. Setiap response dalam batchItems adalah salah satu jenis berikut:

SearchAddressReverseResponse - Jika kueri berhasil diselesaikan.
Error - Jika kueri gagal. Respons akan berisi code dan message dalam kasus ini.

Berikut adalah sampel Respons Batch dengan 2 berhasil dan 1 gagal hasil:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	string	Id batch untuk mengkueri operasi.
api-version	query	True	string	Nomor versi Azure Maps API.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menunjukkan akun yang dimaksudkan untuk digunakan dengan model keamanan Microsoft Entra ID. ID unik untuk akun Azure Maps ini dapat diperoleh dari API Akun sarana manajemen Azure Maps. Untuk informasi selengkapnya tentang menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat Mengelola autentikasi di Azure Maps.

Respons

Nama	Jenis	Deskripsi
200 OK	ReverseSearchAddressBatchProcessResult	OK
202 Accepted		Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya. Header Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

ReverseSearchAddressBatchProcessResult

202 Accepted

Hanya didukung untuk permintaan asinkron. Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Lokasi untuk mencoba kembali atau mengakses hasilnya.

Header

Location: string

Other Status Codes

ErrorResponse

Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Microsoft Entra OAuth 2.0 Flows. Saat dipasangkan dengan akses berbasis peran Azure kontrol dapat digunakan untuk mengontrol akses ke REST API Azure Maps. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya Atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin ke REST API Azure Maps.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi . Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Nota

Definisi keamanan ini mengharuskan penggunaan header x-ms-client-id untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari api manajemen Maps.
Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi ID Microsoft Entra.
Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.
Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.
Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft .

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Microsoft Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses REST API Azure Maps sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol butir halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun peta untuk membatasi penyalahgunaan penyajian dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Permintaan sampel

HTTP

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Respon sampel

Kode status:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Kode status:: 202

Definisi

Nama	Deskripsi
Address	Alamat hasilnya.
AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.
BoundingBoxCompassNotation	Kotak pembatas lokasi.
Brand	Merek yang terkait dengan POI
Classification	Klasifikasi untuk POI yang dikembalikan
ClassificationName	Nama untuk klasifikasi
DataSources	Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.
Entity	Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
EntryPoint	Titik masuk untuk POI yang dikembalikan.
EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau minor .
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
Geometry	Informasi tentang bentuk geometrik hasil. Hanya ada jika jenis == Geografi.
LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
MatchType	Jenis kecocokan untuk operasi pencarian alamat terbalik.
OperatingHours	Jam buka untuk POI (Tempat Menarik).
OperatingHoursTime	Mewakili tanggal dan waktu
OperatingHoursTimeRange	Buka rentang waktu selama sehari
PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
PointOfInterestCategorySet	Kategori POI
QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. Penting: Properti ini tidak digunakan lagi dan dapat dihilangkan dari respons.
Response	Hasil kueri. SearchAddressResult jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
ReverseSearchAddressBatchItem	Item yang dikembalikan dari panggilan layanan Batch Terbalik Alamat Pencarian.
ReverseSearchAddressBatchProcessResult	Objek ini dikembalikan dari panggilan layanan Batch Terbalik Alamat Pencarian yang berhasil.
SearchAddressResultItem	Objek hasil untuk respons SEARCH API.
SearchAddressResultType	Salah satu dari: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
SearchSummary	Objek ringkasan untuk respons SEARCH API.
Summary	Ringkasan hasil untuk permintaan batch

Address

Objek

Alamat hasilnya.

Nama	Jenis	Deskripsi
boundingBox	BoundingBoxCompassNotation	Menentukan kotak pembatas untuk lokasi. Properti ini hanya dikembalikan oleh Search Address Reverse API. Semua Search API lainnya mengembalikan `viewport` properti `SearchAddressResultItem` objek.
buildingNumber	string	Nomor bangunan di jalan. Penting: Properti ini tidak digunakan lagi. Gunakan `streetNumber` sebagai gantinya.
country	string	Nama negara/wilayah.
countryCode	string	Kode alfabet dua huruf yang ditentukan oleh standar ISO 3166-1 Alpha-2 untuk mewakili negara/wilayah dan wilayah dependen.
countryCodeISO3	string	Kode alfabet tiga huruf yang ditentukan oleh standar ISO 3166-1 Alpha-3 untuk mewakili negara/wilayah dan wilayah dependen.
countrySecondarySubdivision	string	Divisi administratif tingkat kedua dalam suatu negara/wilayah. Ini mengidentifikasi subdivisi yang berada di bawah subdivisi utama, seperti negara bagian atau provinsi, tetapi di atas unit yang lebih kecil seperti kotamadya atau lingkungan. Contohnya termasuk County di Amerika Serikat dan District di Inggris Raya.
countrySubdivision	string	Pembagian administratif utama dalam suatu negara, seperti negara bagian, provinsi. Ini digunakan untuk mewakili subdivisi tingkat pertama di bawah tingkat nasional.
countrySubdivisionCode	string	`countrySubdivisionCode` diawali oleh `countryCode` ( countryCode-countrySubdivisionCode ) dan tanda hubung membentuk kode ISO 3166-2. Contoh: TX untuk Texas, SCT untuk Skotlandia dan ON untuk Ontario. Properti ini tidak tersedia di `Get Search NearbyGet Search POI` dan API.
countrySubdivisionName	string	Mewakili nama lengkap divisi administratif tingkat pertama (seperti negara bagian, provinsi, atau wilayah) dalam suatu negara atau wilayah. Properti ini disertakan hanya jika `countrySubdivision` nilai diberikan dalam bentuk singkat. Saat ini didukung untuk Amerika Serikat, Kanada, dan Inggris Raya.
countryTertiarySubdivision	string	Divisi administratif tingkat ketiga dalam suatu negara/wilayah. Ini memberikan perincian yang lebih halus daripada subdivisi sekunder (seperti kabupaten atau distrik). Contohnya termasuk kotamadya seperti kota, kota, desa, borough, atau kotapraja dan lingkungan yang lebih kecil dan wilayah geografis informal dalam kotamadya seperti Capitol Hill, Green Lake, dan Wallingford di Seattle.
crossStreet	string	Nama jalan yang disilangkan. Properti ini hanya tersedia di `Get Search Address Reverse Cross Street` API.
extendedPostalCode	string	Kode pos yang diperluas mengacu pada format kode pos yang melampaui kumpulan digit standar untuk memberikan presisi lokasi yang lebih besar. Ini biasanya digunakan dalam sistem seperti kode U.S. ZIP+4 atau format diperluas serupa di negara/wilayah lain. Ketersediaan tergantung pada wilayah. Tidak tersedia di `Get Search Address Reverse Cross Street` API.
freeformAddress	string	Baris alamat yang diformat sesuai dengan aturan pemformatan negara/wilayah asal hasil, atau dalam kasus negara/wilayah, nama negara/wilayah lengkapnya.
localName	string	Komponen alamat yang mewakili nama area geografis atau lokalitas yang mengelompokkan beberapa objek yang dapat diatasi untuk tujuan alamat, tanpa menjadi unit administratif. Bidang ini digunakan untuk membangun properti `freeformAddress`. `localName` mewakili kotamadya pos. Tergantung pada lokasinya, `localName` adalah nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, gunakan `localName` alih-alih `municipality`.
municipality	string	Kota/Kota Catatan: `municipality` mewakili kotamadya perumahan. Tergantung pada lokasinya, nilai `municipality` mungkin berbeda dari nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, disarankan agar `localName` nilai tersebut digunakan sebagai pengganti nilai.`municipality`
municipalitySubdivision	string	Subdivisi dalam kotamadya. Ini mewakili unit administratif atau geografis yang lebih kecil di dalam kota, kota, atau entitas kota lainnya.
neighbourhood	string	Lingkungan adalah area yang dilokalkan secara geografis di dalam kota atau kota dengan karakteristik khas dan interaksi sosial antara penduduk.
postalCode	string	Serangkaian angka atau huruf (atau keduanya) ditambahkan ke alamat untuk membantu mengidentifikasi wilayah geografis tertentu. Kode Pos adalah kode pos versi AS, negara/wilayah lain menggunakan format lain seperti Kode Pos, Kode PIN, dan PLZ.
routeNumbers	string[]	Kode-kode yang digunakan untuk mengidentifikasi jalan dengan jelas. Hanya tersedia untuk Search Address Reverse API.
street	string	Nama jalan. Penting: Properti ini tidak digunakan lagi. Gunakan `streetName` sebagai gantinya.
streetName	string	Nama jalan.
streetNameAndNumber	string	Nama dan nomor jalan. Hanya tersedia untuk Search Address Reverse API.
streetNumber	string	Nomor bangunan di jalan. Tidak tersedia di `Get Search Address Reverse Cross Street` API.

AddressRanges

Objek

Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.

Nama	Jenis	Deskripsi
from	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
rangeLeft	string	Rentang alamat di sisi kiri jalan.
rangeRight	string	Rentang alamat di sisi kanan jalan.
to	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BoundingBox

Objek

Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.

Nama	Jenis	Deskripsi
btmRightPoint	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

BoundingBoxCompassNotation

Objek

Kotak pembatas lokasi.

Nama	Jenis	Deskripsi
entity	Entity	Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
northEast	string	Garis lintang timur laut, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma
southWest	string	Garis lintang barat daya, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma

Brand

Objek

Merek yang terkait dengan POI

Nama	Jenis	Deskripsi
name	string	Nama merek

Classification

Objek

Klasifikasi untuk POI yang dikembalikan

Nama	Jenis	Deskripsi
code	string	Properti kode
names	ClassificationName[]	Array nama

ClassificationName

Objek

Nama untuk klasifikasi

Nama	Jenis	Deskripsi
name	string	Properti nama
nameLocale	string	Properti Nama Lokal

DataSources

Objek

Bagian opsional. Id referensi untuk digunakan dengan Get Search Polygon API.

Nama	Jenis	Deskripsi
geometry	Geometry	Informasi tentang bentuk geometrik hasil. Hanya ada jika jenis == Geografi.

Entity

Enumerasi

Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.

Nilai	Deskripsi
position	Entitas posisi

EntryPoint

Objek

Titik masuk untuk POI yang dikembalikan.

Nama	Jenis	Deskripsi
position	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
type	EntryPointType	Jenis titik masuk. Nilai dapat berupa utama atau minor .

EntryPointType

Enumerasi

Jenis titik masuk. Nilai dapat berupa utama atau minor .

Nilai	Deskripsi
main
minor

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GeographicEntityType

Enumerasi

Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.

Nilai	Deskripsi
Country	nama negara/wilayah
CountrySubdivision	Negara Bagian atau Provinsi
CountrySecondarySubdivision	County
CountryTertiarySubdivision	Area Bernama
Municipality	Kota/Kota
MunicipalitySubdivision	Sub / Kota Super
Neighbourhood	Lingkungan
PostalCodeArea	Kode Pos / Kode Pos

Geometry

Objek

Informasi tentang bentuk geometrik hasil. Hanya ada jika jenis == Geografi.

Nama	Jenis	Deskripsi
id	string	Teruskan ini sebagai geometryId ke Get Search Polygon API untuk mengambil informasi geometri untuk hasil ini.

LatLongPairAbbreviated

Objek

Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

Nama	Jenis	Deskripsi
lat	number (double)	Properti garis lintang
lon	number (double)	Properti garis bujur

MatchType

Enumerasi

Jenis kecocokan untuk operasi pencarian alamat terbalik.

Nilai	Deskripsi
AddressPoint
HouseNumberRange
Street

OperatingHours

Objek

Jam buka untuk POI (Tempat Menarik).

Nama	Jenis	Deskripsi
mode	string	Nilai yang digunakan dalam permintaan: tidak ada atau "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Daftar rentang waktu selama 7 hari ke depan

OperatingHoursTime

Objek

Mewakili tanggal dan waktu

Nama	Jenis	Deskripsi
date	string	Mewakili tanggal kalender saat ini di zona waktu POI, misalnya "2019-02-07".
hour	integer	Jam dalam format 24 jam dalam waktu lokal POI; nilai yang mungkin adalah 0 - 23.
minute	integer	Menit berada di waktu lokal POI; nilai yang mungkin adalah 0 - 59.

OperatingHoursTimeRange

Objek

Buka rentang waktu selama sehari

Nama	Jenis	Deskripsi
endTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika POI tertentu sedang ditutup, atau awal rentang jika ditutup sebelum rentang.
startTime	OperatingHoursTime	Titik dalam rentang 7 hari berikutnya ketika POI tertentu sedang dibuka, atau awal rentang jika dibuka sebelum rentang.

PointOfInterest

Objek

Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.

Nama	Jenis	Deskripsi
brands	Brand[]	Array merek. Nama merek untuk POI yang dikembalikan.
categories	string[]	Array kategori
categorySet	PointOfInterestCategorySet[]	Daftar kategori POI yang paling spesifik
classifications	Classification[]	Array klasifikasi
name	string	Nama properti POI
openingHours	OperatingHours	Jam buka untuk POI (Tempat Menarik).
phone	string	Properti nomor telepon
url	string	Properti URL Situs Web

PointOfInterestCategorySet

Objek

Kategori POI

Nama	Jenis	Deskripsi
id	integer	ID Kategori

QueryType

Enumerasi

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

Penting: Properti ini tidak digunakan lagi dan dapat dihilangkan dari respons.

Nilai	Deskripsi
NEARBY	Pencarian dilakukan di sekitar garis lintang dan bujur tertentu dengan jari-jari yang ditentukan.
NON_NEAR	Pencarian dilakukan secara global, tanpa bias pada garis lintang dan bujur tertentu, dan tidak ada radius yang ditentukan

Response

Objek

Hasil kueri. SearchAddressResult jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.
results	SearchAddressResultItem[]	Daftar hasil Search API.
summary	SearchSummary	Objek ringkasan untuk respons SEARCH API

ReverseSearchAddressBatchItem

Objek

Item yang dikembalikan dari panggilan layanan Batch Terbalik Alamat Pencarian.

Nama	Jenis	Deskripsi
response	Response	Hasil kueri. SearchAddressReverseResponse jika kueri berhasil diselesaikan, ErrorResponse sebaliknya.
statusCode	integer	Kode status permintaan HTTP.

ReverseSearchAddressBatchProcessResult

Objek

Objek ini dikembalikan dari panggilan layanan Batch Terbalik Alamat Pencarian yang berhasil.

Nama	Jenis	Deskripsi
batchItems	ReverseSearchAddressBatchItem[]	Array yang berisi hasil batch.
summary	Summary	Ringkasan hasil untuk permintaan batch

SearchAddressResultItem

Objek

Objek hasil untuk respons SEARCH API.

Nama	Jenis	Deskripsi
address	Address	Alamat hasilnya.
addressRanges	AddressRanges	Menjelaskan rentang alamat di kedua sisi jalan untuk hasil pencarian. Koordinat untuk lokasi awal dan akhir rentang alamat disertakan.
dataSources	DataSources	Bagian opsional. Mereferensikan id geometri untuk digunakan dengan Get Search Polygon API.
detourTime	integer	Waktu memutar dalam detik. Hanya dikembalikan untuk panggilan ke Search Along Route API.
dist	number (double)	Jarak garis lurus antara lokasi hasil dan geobias dalam meter.
entityType	GeographicEntityType	Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
entryPoints	EntryPoint[]	Array Titik Masuk. Mereka menjelaskan jenis pintu masuk yang tersedia di lokasi. Jenisnya bisa menjadi "utama" untuk pintu masuk utama seperti pintu depan, atau lobi, dan "kecil", untuk pintu samping dan belakang.
id	string	Properti id
info	string	Informasi tentang sumber data asli Hasil. Digunakan untuk permintaan dukungan.
matchType	MatchType	Informasi tentang jenis kecocokan. Salah satu dari: AddressPoint HouseNumberRange Jalan
poi	PointOfInterest	Detail POI yang dikembalikan termasuk informasi seperti nama, telepon, alamat url, dan klasifikasi.
position	LatLongPairAbbreviated	Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
score	number (double)	Nilai dalam hasil diatur untuk menunjukkan skor pencocokan relatif antara hasil. Anda dapat menggunakan ini untuk menentukan bahwa hasil x dua kali lebih mungkin relevan sebagai hasil y jika nilai x adalah 2x nilai y. Nilai bervariasi di antara kueri dan hanya dimaksudkan sebagai nilai relatif untuk satu tataan hasil. Penting: Properti ini tidak digunakan lagi dan dapat dihilangkan dari respons.
type	SearchAddressResultType	Salah satu dari: POI Jalan Geografi Alamat Titik Rentang Alamat Lintas Jalan
viewport	BoundingBox	Viewport yang mencakup hasil yang diwakili oleh koordinat kiri atas dan kanan bawah viewport.

SearchAddressResultType

Enumerasi

Salah satu dari:

POI
Jalan
Geografi
Alamat Titik
Rentang Alamat
Lintas Jalan

Nilai	Deskripsi
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchSummary

Objek

Objek ringkasan untuk respons SEARCH API.

Nama	Jenis	Deskripsi
fuzzyLevel	integer	Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil.
geoBias	LatLongPairAbbreviated	Indikasi ketika mesin pencari internal telah menerapkan bias geospasial untuk meningkatkan peringkat hasil. Dalam beberapa metode, ini dapat dipengaruhi dengan mengatur parameter lat dan lon jika tersedia. Dalam kasus lain itu murni internal.
limit	integer	Jumlah maksimum respons yang akan dikembalikan
numResults	integer	Jumlah hasil dalam respons.
offset	integer	Offset awal dari Hasil yang dikembalikan dalam kumpulan Hasil lengkap.
query	string	Parameter kueri yang digunakan untuk menghasilkan hasil pencarian ini.
queryTime	integer	Waktu yang dihabiskan untuk menyelesaikan kueri, dalam milidetik.
queryType	QueryType	Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. Penting: Properti ini tidak digunakan lagi dan dapat dihilangkan dari respons.
totalResults	integer	Jumlah total Hasil yang ditemukan.

Summary

Objek

Ringkasan hasil untuk permintaan batch

Nama	Jenis	Deskripsi
successfulRequests	integer	Jumlah permintaan yang berhasil dalam batch
totalRequests	integer	Jumlah total permintaan dalam batch

Bagikan melalui

Search - Get Search Address Reverse Batch

Kirim Permintaan Batch Sinkron

Kirim Permintaan Batch Asinkron

Isi POST untuk Permintaan Batch

Unduh Hasil Batch Asinkron

Model Respons Batch

Parameter URI

Header Permintaan

Respons

Keamanan

AADToken

Cakupan

subscription-key

SAS Token

Contoh

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Permintaan sampel

Respon sampel

Definisi

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary