Справочник "Города" (устарел)
Описание
Получение городов.
Данный метод устарел. Он остается рабочим, однако вместо него мы рекомендуем пользоваться другими методами получения городов:
Структура URL
1 | GET /v2/references/towns/by/ids
|
Список параметров
Название | Описание | Тип передачи параметра | Обязательный(+)/По умолчанию(значение) |
---|---|---|---|
language |
Язык локализации. Описание использования. | Query string parameter | ru |
ids |
Дополнительные параметры фильтрации. | Query string parameter | |
query |
Текст для поиска. | Query string parameter | |
areaIds |
Дополнительно: массив идентификаторов областей. | Query string parameter | |
countrySigns |
Дополнительно: массив кодов стран в формате ISO 3166-1 alpha-2. | Query string parameter | |
queryLimit |
Желаемое количество ответов, максимум 100. | Query string parameter | 10 |
Особенности формирования запроса
- В запросе должен быть обязательно указан параметр
ids
(?ids=2,4,7
) или параметрquery
(?query=test
) - Параметр
areaIds
работает только в том случае, когда в запросе присутствует также параметрcountrySigns
.
Результат
Массив структур "Город".
Примеры запросов и ответов
Использование параметра ids
ids
1 | curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns?ids=137,138&language=uk" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | [ { "id": 137, "name": "Київ", "countrySign": "UA", "areaId": 23, "lat": 50.444795, "lon": 30.528718, "postcode": [ "01000-06999", "12345" ] }, { "id": 138, "name": "Васильків", "countrySign": "UA", "areaId": 23, "lat": 50.177089, "lon": 30.319639, "postcode": [ "08600-08606" ] } ] |
Использование параметра query
query
+ countrySigns
+ queryLimit
1 | curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns?query=kras&countrySigns=UA,RU&queryLimit=5&language=uk" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | [ { "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
+ areaIds
1 | curl -X GET -H "Accept: application/json" -H "Authorization: 3WQ1EQ465C4005000130" "https://api.lardi-trans.com/v2/references/towns?query=kras&areaIds=73,32,34&countrySigns=UA,RU&language=uk" |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | [ { "id": 578, "name": "Краснодар", "countrySign": "RU", "areaId": 73, "lat": 45.034942, "lon": 38.976032 }, { "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 }, { "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" ] }, { "id": 122808, "name": "Красне", "countrySign": "UA", "areaId": 32, "lat": 51.319538, "lon": 33.727001, "postcode": [ "41507" ] }, { "id": 122867, "name": "Красичка", "countrySign": "UA", "areaId": 32, "lat": 52.186432, "lon": 33.759609, "postcode": [ "41034" ] }, { "id": 8150, "name": "Красна Поляна", "countrySign": "RU", "areaId": 73, "lat": 45.356751, "lon": 40.863563 } ] |