Перейти до змісту

Отримання міст за назвою міста

Опис

Отримання міст за назвою міста. Можна вказувати тільки частину назви.

Структура URL

GET /v2/references/towns/by/name

Список параметрів

Назва Опис Тип передачі параметра Обов'язковий(+)/За замовчуванням(значення)
language Мова локалізації. Опис використання. Query string parameter ru
areaIds Додатково: масив ідентифікаторів областей. Обмеження використання: цей параметр враховується тільки у тому разі, коли вказано хоча б одне значення в параметрі countrySigns. Ефект: до вибірки потраплять тільки ті міста, чиї області вказані як значення цього параметра. Query string parameter
countrySigns Додатково: масив кодів країн у форматі ISO 3166-1 alpha-2. Ефект: до вибірки потраплять тільки ті міста, чиї країни вказані як значення цього параметра. Query string parameter
excludeCountrySigns Додатково: масив кодів країн у форматі ISO 3166-1 alpha-2. Обмеження використання: цей параметр враховується тільки у тому разі, коли не вказано жодного значення в параметрі countrySigns. Ефект: до вибірки потраплять тільки ті міста, чиї країни не вказані як значення цього параметра. Query string parameter
limit Бажана кількість відповідей, максимум 100. Query string parameter 10
query Назва або частина назви міста. Query string parameter +

Результат

Масив структур "Місто".

Зразки запитів і відповідей

query
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/name?language=uk&query=kras&limit=5"
[
    {
        "id": 1511,
        "name": "Красноярськ",
        "countrySign": "RU",
        "areaId": 74,
        "lat": 56.008711,
        "lon": 92.870412,
        "postcode": [
            "660000"
        ]
    },
    {
        "id": 578,
        "name": "Краснодар",
        "countrySign": "RU",
        "areaId": 73,
        "lat": 45.034942,
        "lon": 38.976032
    },
    {
        "id": 89,
        "name": "Красноперекопськ",
        "countrySign": "UA",
        "areaId": 25,
        "lat": 45.952198,
        "lon": 33.795077,
        "postcode": [
            "96000-96005"
        ]
    },
    {
        "id": 4337,
        "name": "Краснопілля",
        "countrySign": "UA",
        "areaId": 32,
        "lat": 50.767108,
        "lon": 35.267666,
        "postcode": [
            "42400"
        ]
    },
    {
        "id": 6529,
        "name": "Краснокутськ",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 50.055979,
        "lon": 35.147628
    }
]
query + countrySigns
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/name?language=uk&query=kras&countrySigns=PL"
[
    {
        "id": 5616,
        "name": "Краснистав",
        "countrySign": "PL",
        "areaId": 149,
        "lat": 50.982614,
        "lon": 23.172465,
        "postcode": [
            "22-300"
        ]
    },
    {
        "id": 113339,
        "name": "Красеюв",
        "countrySign": "PL",
        "areaId": 154,
        "lat": 50.668569,
        "lon": 18.248019,
        "postcode": [
            "46-040"
        ]
    }
]
query + countrySigns + areaIds
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/name?language=uk&query=kras&countrySigns=UA&areaIds=34"
[
    {
        "id": 6529,
        "name": "Краснокутськ",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 50.055979,
        "lon": 35.147628
    },
    {
        "id": 72,
        "name": "Красноград",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.373049,
        "lon": 35.461353,
        "postcode": [
            "63300"
        ]
    },
    {
        "id": 68,
        "name": "Краснопавлівка",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.137419,
        "lon": 36.3239,
        "postcode": [
            "64622"
        ]
    },
    {
        "id": 131706,
        "name": "Краснопавлівське",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.21291,
        "lon": 36.297798,
        "postcode": [
            "64143"
        ]
    },
    {
        "id": 122810,
        "name": "Красне Перше",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.943676,
        "lon": 37.755707,
        "postcode": [
            "62710"
        ]
    }
]
query + excludeCountrySigns
curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/name?language=uk&query=kras&excludeCountrySigns=UA,RU,PL"
[
    {
        "id": 4868,
        "name": "Красне",
        "countrySign": "BY",
        "areaId": 127,
        "lat": 52.679631,
        "lon": 24.363496
    },
    {
        "id": 114805,
        "name": "Красен",
        "countrySign": "BG",
        "areaId": 0,
        "lat": 43.74045,
        "lon": 25.98316
    }
]