На главную

Метод Database.GetCities

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

Страница документации ВКонтакте database.getCities.

Синтаксис

public ReadOnlyCollection<City> GetCities(
	int countryId,
	int? regionId = null,
	string query = "",
	bool? needAll = false,
	int? count = null,
	int? offset = null
)

Параметры

• countryId - Идентификатор страны, полученный в методе database.getCountries. положительное число, обязательный параметр
• regionId - Идентификатор региона, города которого необходимо получить. (параметр не обязателен) положительное число
• query - Строка поискового запроса. Например, Санкт. строка
• needAll - 1 – возвращать все города. 0 – возвращать только основные города. флаг, может принимать значения 1 или 0
• offset - Отступ, необходимый для получения определенного подмножества городов. положительное число
• count - Количество городов, которые необходимо вернуть. положительное число, по умолчанию 100, максимальное значение 1000

Результат

Возвращает массив объектов city, каждый из которых содержит поля cid и title. При наличии информации о регионе и/или области, в которых находится данный город, в объекте могут дополнительно включаться поля area и region. Если не задан параметр q, то будет возвращен список самых крупных городов в заданной стране. Если задан параметр q, то будет возвращен список городов, которые релевантны поисковому запросу.

Замечания

• Если не задан параметр query, то будет возвращен список самых крупных городов в заданной стране.
• Если задан параметр query то будет возвращен список городов, которые релевантны поисковому запросу.

Пример

ReadOnlyCollection<City> cities = api.Database.GetCities(1, count: 3);

Версия Вконтакте API v.5.44

Дата обновления: 29.01.2016 12:42:38