Получение списка городов [1.0]

Описание

Получение списка всех городов с возможностью поиска по префиксу имени, по id городов или только по названию города.

Структура URL

HTTP метод: GET, ресурс: <base_url>/dictionaries/cities

Параметры

НазваниеОписаниеСпособ передачи параметраОбязательный
nameСлово для поиска в поле FullNameURL 
idsСписок id городов, которые нужно вернутьURL 
includedFieldsСписок полей, которые нужно вернутьURL 

Результат

Список структур "Город"

Пример 1

Запрос на получение страны по id города

GET, http://api.ati.su/dictionaries/cities?ids=1,3611&includedFields=CountryName,CountryId

Ответ

[  
   {  
      "CityId":1,
      "CountryId":1,
      "CountryName":"Россия"
   },
   {  
      "CityId":3611,
      "CountryId":1,
      "CountryName":"Россия"
   }
]

Пример 2

Запрос на получение списка городов по вхождению параметра name в полное название

GET, http://api.ati.su/dictionaries/cities?name=Красноярск&includedFields=FullName

Ответ

[  
    {
        "CityId": 7,
        "FullName": "Ачинск, Красноярский край, Россия"
    },
    {
        "CityId": 116,
        "FullName": "Красноярск, Красноярский край, Россия"
    }
]

Пример 3

Запрос на получение списка городов по вхождению параметра name только в название города

GET, http://api.ati.su/dictionaries/cities?name=Красноярск&includedFields=FullName&cityNameOnly=true

Ответ

[
    {
        "CityId": 116,
        "FullName": "Красноярск, Красноярский край, Россия"
    },
    {
        "CityId": 6358,
        "FullName": "Красноярский, Оренбургская область, Россия"
    }
]

Примечание:

1) В случае, если указаны параметр name параметр ids, поиск городов будет произведен по параметру name, параметр ids учитываться не будет;

2) При отсутствии параметра includedFields, будут выданы все возможные поля;

3) При любом значении параметра includedFields будет возвращено поле CityId

4) Если NameOnly=true, поиск только по названию города. Если NameOnly=false, поиск совпадений по всей строке fullName.

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

Код ответаСообщение
200Операция завершена успешно