Проект

Общее

Профиль

CommonAPIgetCatalogsList » История » Редакция 2

Редакция 1 (Артем, 17.06.2016 19:15) → Редакция 2/14 (Артем, 17.06.2016 19:19)

h1. getCatalogsList 


 h2. Описание метода 

 --- 

 p(. Метод возвращает список всех подключенных каталогов. Возвращаемые данные могут быть как в формате json, так и оформленны в теги html. 

 --- 

 h2. Параметры вызова 

 p(.  
 |=.параметр|=.обязательный|=.описание|возможные значения|значение по умолчанию| 
 |*clientId*|=.-|ID клиента||Если параметр clientId не задан, то метод вернет все возможные каталоги| клиента||| 
 |*format*|=.-|формат возвращаемых данных|html или json|html| 
 |*splitByRegion*|=.-|Разделать ли данные по регионам|on или off|on| 
 |*language*|=.-|Язык|ru или en|ru| 
 |*isNeedLocaleName*|=.-|Нужно ли отображать локализованное название бренда|on или off|off| 
 |*isNeedLocaleNameWrap*|=.-|Нужно ли <BR> перед локализованным названием бренда|on или off|off| 
 |*isNeedOwnClasses*|=.-|Нужно задавать отдельные классы для html-тегов|on или off|off| 

 3 последних параметра действуют только тогда, когда запрашиваются данные в формате html 


 h2. Возвращаемые данные 

 --- 

 Возвращает список ссылок на каталоги. 

 h2. Формат html 
 <pre><code class="php"> 
   Place your code here. 
 </code></pre>