Проект

Общее

Профиль

CommonAPIgetCatalogsList » История » Версия 6

Артем, 17.06.2016 20:18

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 5 Артем
|*buttonType*|=.-|Тип кнопки|defaultWithShadow или defaultWithoutShadow|defaultWithoutShadow|
24 1 Артем
25 5 Артем
Последние 4 параметра действуют только тогда, когда запрашиваются данные в формате html
26 1 Артем
27
28
h2. Возвращаемые данные
29
30
---
31
32
Возвращает список ссылок на каталоги.
33
34 5 Артем
h2. Пример php-кода страницы, запрашивающей данные в формате html:
35
36 2 Артем
<pre><code class="php">
37 6 Артем
<?
38 4 Артем
header("Content-type: text/html; charset=utf-8");
39
?>
40
<html>
41
<head>
42
  <link rel="stylesheet" href="ilcats.css">
43
</head>
44
45
<body>
46
<span class='ilcatsCss'>
47
<?php
48
49
$st = file_get_contents("http://commonapi.ilcats.ru/getCatalogsList/?splitByRegion=off&format=html&language=ru&isNeedLocaleName=on&isNeedLocaleNameWrap=on&buttonType=defaultWithShadow&clientId=");
50
echo $st;
51
52
?>
53
</span>
54 1 Артем
</body>
55
56
</html>
57
</code></pre>
58 5 Артем
59
Соответствующий файл таблицы каскадных стилей:
60
<pre><code class="css">
61
.divButtonIlcatsCatalog {
62
	text-align: center;
63
	float: left;
64
	font-size: 12px;
65
	text-decorations: none;
66
	width: 130px;
67
}
68 6 Артем
.divButtonIlcatsCatalog a:link, a:visited {
69 5 Артем
	text-align: center;
70
	float: left;
71
	font-size: 12px;
72
	text-decoration: none;
73
	color: green;
74
	font-weight: bold;
75
}
76
77
.divRegionIlcatsCatalog {
78
	float: left;
79
    width: 100%;
80
    margin: 0px 0px 50px 0px;
81
}
82 6 Артем
.divRegionIlcatsCatalog H2 {
83 5 Артем
	color: #585f69;
84
    margin-top: 5px;
85
    text-shadow: none;
86
    font-weight: normal;
87
    font-family: 'Open Sans', sans-serif;
88
    font-size: 24px;
89
    line-height: 33px;
90
}
91
</pre>