Геокодувати адресу
Geocoder.geocode
Перетворює структуровану адресу з обов’язковим полем city на координати й дані відповідного адресного запису.
Параметри body
| Тіло запиту | Тип | Опис |
|---|---|---|
address | object ОБОВ’ЯЗКОВЕ | Передайте об’єкт адреси з обов’язковим полем city. Інші поля необов’язкові; вкажіть достатньо даних для пошуку збігу. |
country | string | Необов’язковий код країни. Відсутнє або null означає PL; порожнє значення лишається порожнім. Для польських адрес використовуйте PL великими літерами. Міжнародне геокодування потребує відповідного доступу. |
province | string | Необов’язкова назва воєводства; автоматично не заповнюється. |
district | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
community | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
city | string ОБОВ’ЯЗКОВЕ | Назва міста city обов’язкова в кожній адресі, зокрема для PL. |
quarter | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
pcode | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
street | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
house | string | Необов’язкове. Відсутнє або null дає порожній рядок. |
maxResult | integer | Для польських адрес не більш ніж 1–3 збіги на адресу (типово 1). Значення поза діапазоном обмежуються до 1–3. Задайте maxResult у кожній адресі; maxResults не задає цей ліміт. |
Приклад запиту
{
"address": {
"country": "PL",
"city": "Warszawa",
"street": "Domaniewska",
"house": "37"
}
}Приклад відповіді
{
"result": [
{
"quality": 9,
"x": 21.0071318,
"y": 52.18284,
"country": "PL",
"province": "mazowieckie",
"district": "Warszawa",
"community": "Warszawa",
"city": "Warszawa",
"quarter": "Mokotów",
"pcode": "02-672",
"street": "Domaniewska",
"house": "37",
"resultRadius": 0,
"flat": ""
}
]
}Приклад показує вибрані поля відповіді. Фактичні координати й поштові дані залежать від вхідних даних та актуальних картографічних даних; також можуть бути присутні розширені поля, доступні за окремими дозволами.
поля result
| поля result | Тип | Опис |
|---|---|---|
quality | integer | Geocoding quality score. |
x | double | Longitude (WGS84). |
y | double | Latitude (WGS84). |
country | string | Country code. |
province | string | Province. |
district | string | District (powiat). |
community | string | Community (gmina). |
city | string | City. |
quarter | string | Quarter. |
pcode | string | Postal code (PL only). |
street | string | Street. |
house | string | House number. |
addressType | integer РОЗШИРЕНЕ | Building type. Extended. |
peoplesForAddress | integer РОЗШИРЕНЕ | Residents at address. Extended. |
flatsForAddress | integer РОЗШИРЕНЕ | Flats at address. Extended. |
buildingsForAddress | integer РОЗШИРЕНЕ | Buildings at address. Extended. |
pcodeExtraInfo | object[] РОЗШИРЕНЕ | Extra postal-code info. Extended. |
resultRadius | number | Result envelope radius (m). -1 if unknown. |
mapLink | string | Link to map result. |