Просмотр исходного текста страницы CBPv4 (метод)

Данный метод (''аббр. - City By Part'') является частью коммерческого набора методов post-API.ru и предназначен для поиска населенных пунктов по части их названия. Метод может быть использован следующим образом.
* По мере ввода пользователем фрагмента города, под полем ввода появляется выпадающий список, в котором отображается список подходящих городов, с указанием района и области, в котором они расположены. При этом удовлетворяющий условию фрагмент - подсвечивается.


== Версия API ==
  Версия 4.0

== Вызов ==
  http://api.post-api.ru:3300/api/v4/cbp?d=1&apikey=dev&city=Санк

== Параметры ==

{| border="1" cellspacing="0" cellpadding="5px"
|+
|Ключ||Обязательный||Описание
|-
|'''city'''||О||Часть наименования населенного пункта.
|-
|'''cityonly'''||Н||Исключить из результирующей выборки села, поселки и прочие населенные пункты, не являющиеся городами. "0" - включены объекты все типов (''значение по умолчанию''),  "1" - включены только города.
|-
|'''hl'''||Н||Подсветка части городов, совпадающей с поисковой маской в результирующей строке [[routev4|route]]/formatname.
|-
|'''limit'''||Н||Количество возвращаемых адресных объектов
|-
|'''apikey'''||О||[[ApiKey|Ключ доступа к API]].
|-
|'''d'''||Н||[[Отладочный_режим|Отладочный режим]].
|}


== Возвращаемое значение ==

С этим методом связаны следующие массивы-ответы: [[CBPv4_content]], [[routev4]], [[mkadv4]].

При успешном выполнении запроса возвращается следующий массив-ответ.

  status:
    time: 0.04421359         - Время выполнения скрипта без учета сетевых задержек
    status: success          - Сформирован успешный ответ
    access: granted          - Доступ по [[ApiKey]] предоставлен
    debug: 1                 - Включен режим демонстрационного вывода данных
    v: '4.0'                 - Версия API
  source:
    method: CBP              - Вызванный метод
    city: Санк               - Часть города для поиска
    cityonly: 0              - Искать города и населенные пункты других типов
    hl: 0                    - Подсвечивать результат поиска
    limit: 50                - Ограничить результат поисков 50 записями
  content:                   - Результат работы скрипта: [[CBPv4_Content|CBP Content]]
    0: route:
    1: route:
    2: route:
    3: route:
  error:               
    errcode: 0               - Нет ошибки
    errmsg:                  - Текст ошибки
    errname: success         - Текстовое обозначение ошибки


При не успешном выполнении метода возвращается массив-ответ с ошибкой

  status:
    time: 0.001974826
    status: error                                         - Ошибка. Ответ не сформирован
    access: granted
    debug: 1
    v: '4.0'
  source:
    method: CBP 
    city: С
    cityonly: 0  
    hl: 0  
    limit: 50 
  content: {}
  error: 
    errcode: 150                                           - Код ошибки
    errmsg: Необходимо ввести почтовый индекс из 6 цифр    - Текст ошибки
    errname: very-short                                    - Текстовое обозначение ошибки


== Особенности ==
# Сортировка населенных пунктов идет сначала по aolevel, потом по позиции вхождения подстроки. То есть при прочих равных, "г. '''Вор'''онеж" будет находиться в выдаче раньше "г. По'''вор'''ской" 

== Обсуждение ==
  нет

== Примеры использования ==
* нет

== Фрагменты кода ==
нет

== История ==
* 20.10.2013 - Метод создан

[[Категория:Методы|ABI (определение адреса по почтовому индексу)]]
[[Категория:Post-API.ru_v4]]