Получение городов по почтовому индексу

Описание

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

Структура URL

GET /v2/references/towns/by/postcode

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

Название	Описание	Тип передачи параметра	Обязательный(+)/По умолчанию(значение)
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/postcode?language=uk&query=001"

[
    {
        "id": 2791,
        "name": "Єреван",
        "countrySign": "AM",
        "areaId": 0,
        "lat": 40.17765,
        "lon": 44.50532,
        ...
    },
    {
        "id": 5496,
        "name": "Лідо-ді-Остія",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.732715,
        "lon": 12.276943,
        ...
    },
    {
        "id": 112928,
        "name": "Катовіце",
        "countrySign": "PL",
        "areaId": 158,
        "lat": 50.259899,
        "lon": 19.021585,
        ...
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        ...
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        ...
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        ...
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        ...
    }
]

query + countrySigns

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&countrySigns=PL"

[
    {
        "id": 112928,
        "name": "Катовіце",
        "countrySign": "PL",
        "areaId": 158,
        "lat": 50.259899,
        "lon": 19.021585,
        ...
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        ...
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        ...
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        ...
    }
]

query + countrySigns + areaIds

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&countrySigns=PL&areaIds=160,161"

[
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        ...
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        ...
    }
]

query + excludeCountrySigns

curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns/by/postcode?language=uk&query=001&excludeCountrySigns=AM,PL"

[
    {
        "id": 5496,
        "name": "Лідо-ді-Остія",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.732715,
        "lon": 12.276943,
        ...
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        ...
    }
]