CommonAPIgetCatalogsList » История » Версия 3
Артем, 17.06.2016 19:56
1 | 1 | Артем | h1. getCatalogsList |
---|---|---|---|
2 | |||
3 | |||
4 | h2. Описание метода |
||
5 | |||
6 | --- |
||
7 | |||
8 | p(. Метод возвращает список всех подключенных каталогов. Возвращаемые данные могут быть как в формате json, так и оформленны в теги html. |
||
9 | |||
10 | --- |
||
11 | |||
12 | h2. Параметры вызова |
||
13 | |||
14 | p(. |
||
15 | |=.параметр|=.обязательный|=.описание|возможные значения|значение по умолчанию| |
||
16 | 2 | Артем | |*clientId*|=.-|ID клиента||Если параметр clientId не задан, то метод вернет все возможные каталоги| |
17 | 1 | Артем | |*format*|=.-|формат возвращаемых данных|html или json|html| |
18 | 3 | Артем | |*splitByRegion*|=.-|Разделять ли данные по регионам|on или off|on| |
19 | 1 | Артем | |*language*|=.-|Язык|ru или en|ru| |
20 | |*isNeedLocaleName*|=.-|Нужно ли отображать локализованное название бренда|on или off|off| |
||
21 | |*isNeedLocaleNameWrap*|=.-|Нужно ли <BR> перед локализованным названием бренда|on или off|off| |
||
22 | |*isNeedOwnClasses*|=.-|Нужно задавать отдельные классы для html-тегов|on или off|off| |
||
23 | |||
24 | 3 последних параметра действуют только тогда, когда запрашиваются данные в формате html |
||
25 | |||
26 | |||
27 | h2. Возвращаемые данные |
||
28 | |||
29 | --- |
||
30 | |||
31 | Возвращает список ссылок на каталоги. |
||
32 | |||
33 | h2. Формат html |
||
34 | 2 | Артем | <pre><code class="php"> |
35 | Place your code here. |
||
36 | </code></pre> |