database

database.getCities

Возвращает список городов.

Для вызова метода можно использовать:

Параметры

region_id

positive

Идентификатор региона, города которого необходимо получить.

q

string

Строка поискового запроса. Например, «Санкт». Максимальная длина строки — 15 символов.

need_all

checkbox

1 – возвращать все города. 0 – возвращать только основные города.

offset

positive

Отступ, необходимый для получения определенного подмножества городов.

count

positive

Количество городов, которые необходимо вернуть.

Результат

После успешного выполнения возвращает объект, содержащий число результатов в поле count и массив объектов, описывающих города, в поле items.

Каждый объект содержит следующие поля:

id integer Идентификатор города.

title string Название города.

Объект может содержать дополнительные поля:

area string Область.

region string Регион.

Если не задан параметр q, то будет возвращён список самых крупных городов в заданной стране. Если задан параметр q, то будет возвращён список городов, которые релевантны поисковому запросу. Полем important отмечены ключевые города для текущего пользователя.

Коды ошибок

В ходе выполнения могут произойти общие ошибки