Описание
Возвращает список городов.
Пример запроса:
https://vkserfing.ru/api/util.getCities?token=a56a7e1rwr358ee0c14c0e58d992da436&name=Мос
Пример ответа:
{
"status": "success",
"data": {
"total": 2,
"count": 2,
"list": [
{
"id": "1",
"name": "Москва",
"country": {
"id": "1",
"name": "Россия"
}
},
{
"id": "964",
"name": "Новомосковск",
"country": {
"id": "1",
"name": "Россия"
}
}
]
}
}
Параметры
Название | Описание |
---|---|
count | Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 20 |
offset | Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0 |
id | Поиск по ID города |
name | Поиск по названию города. Ищет включение входной строки в названиях городов. |
country | Поиск по стране. Параметр может принимать как ID страны, так и ее название. |
Параметры ответа
Все параметры ответа описывают сами, поэтому разберем только часть из них.
Название | Описание |
---|---|
total | Общее количество найденных результатов. Используется для организации постраничного вывода |
count | Количество возращаемых результатов |