Перейти к содержанию

Получение городов по имени города

Описание

Получение городов по имени города. Можно указывать только часть имени.

Структура 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 Имя или часть имени города, минимум 3 символа. 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,
        ...
    },
    {
        "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,
        ...
    },
    {
        "id": 4337,
        "name": "Краснопілля",
        "countrySign": "UA",
        "areaId": 32,
        "lat": 50.767108,
        "lon": 35.267666,
        ...
    },
    {
        "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,
        ...
    },
    {
        "id": 113339,
        "name": "Красеюв",
        "countrySign": "PL",
        "areaId": 154,
        "lat": 50.668569,
        "lon": 18.248019,
        ...
    }
]
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,
        ...
    },
    {
        "id": 68,
        "name": "Краснопавлівка",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.137419,
        "lon": 36.3239,
        ...
    },
    {
        "id": 131706,
        "name": "Краснопавлівське",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.21291,
        "lon": 36.297798,
        ...
    },
    {
        "id": 122810,
        "name": "Красне Перше",
        "countrySign": "UA",
        "areaId": 34,
        "lat": 49.943676,
        "lon": 37.755707,
        ...
    }
]
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
        ...
    }
]