Отримання міст за поштовим індексом

Опис

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

Структура 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	Поштовий індекс або частина поштового індексу.	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,
        "postcode": [
            "0010"
        ]
    },
    {
        "id": 5496,
        "name": "Лідо-ді-Остія",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.732715,
        "lon": 12.276943,
        "postcode": [
            "00121"
        ]
    },
    {
        "id": 112928,
        "name": "Катовіце",
        "countrySign": "PL",
        "areaId": 158,
        "lat": 50.259899,
        "lon": 19.021585,
        "postcode": [
            "40-001"
        ]
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        "postcode": [
            "36-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        "postcode": [
            "00133"
        ]
    }
]

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,
        "postcode": [
            "40-001"
        ]
    },
    {
        "id": 113124,
        "name": "Хлюдово",
        "countrySign": "PL",
        "areaId": 161,
        "lat": 52.555771,
        "lon": 16.844781,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113127,
        "name": "Тшебовниско",
        "countrySign": "PL",
        "areaId": 155,
        "lat": 50.078002,
        "lon": 22.036459,
        "postcode": [
            "36-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    }
]

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,
        "postcode": [
            "62-001"
        ]
    },
    {
        "id": 113206,
        "name": "Дывиты",
        "countrySign": "PL",
        "areaId": 160,
        "lat": 53.83404,
        "lon": 20.47337,
        "postcode": [
            "11-001"
        ]
    }
]

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,
        "postcode": [
            "00121"
        ]
    },
    {
        "id": 110187,
        "name": "Торренова",
        "countrySign": "IT",
        "areaId": 0,
        "lat": 41.879132,
        "lon": 12.616869,
        "postcode": [
            "00133"
        ]
    }
]