Метод getBrands » История » Версия 3
Артем, 11.03.2019 13:43
| 1 | 1 | Артем | h1. Метод getBrands |
|---|---|---|---|
| 2 | |||
| 3 | --- |
||
| 4 | |||
| 5 | h2. Описание метода |
||
| 6 | |||
| 7 | --- |
||
| 8 | |||
| 9 | p(. Возвращает список доступных производителей автомобилей. |
||
| 10 | |||
| 11 | --- |
||
| 12 | |||
| 13 | h2. Параметры вызова |
||
| 14 | |||
| 15 | --- |
||
| 16 | |||
| 17 | |=.Параметр|Обязательный|=.Описание| |
||
| 18 | |=.*function*|=.+|getBrands| |
||
| 19 | 3 | Артем | |
| 20 | 1 | Артем | |
| 21 | --- |
||
| 22 | |||
| 23 | h2. Пример вызова |
||
| 24 | |||
| 25 | --- |
||
| 26 | |||
| 27 | http://api.ilcats.ru/?clientId=1234567890&domain=www.ilcats.ru&apiKey=abxxxxxxxxxxxxxxxxxxxx98&apiVersion=2.0&function=getBrands |
||
| 28 | |||
| 29 | --- |
||
| 30 | |||
| 31 | h2. Возвращаемые данные |
||
| 32 | |||
| 33 | --- |
||
| 34 | |||
| 35 | 2 | Артем | p(. Метод возвращает массив значений *values* в формате [[ApiMainDataDescriptionIfList|ifList]], содержащий список брендов. |
| 36 | 1 | Артем | |
| 37 | |||
| 38 | |=.Название|=.Обязательн.|=.Описание| |
||
| 39 | |=.*id*|=.+|Числовой ID бренда| |
||
| 40 | |=.*name*|=.+|Название бренда| |
||
| 41 | |=.*groupId*|=.+|ID группы каталогов[1]| |
||
| 42 | |=.*groupName*|=.+|Название группы каталогов| |
||
| 43 | |=.*regionId*|=.+|ID региона каталогов[2]| |
||
| 44 | |=.*regionName*|=.+|Название региона каталогов| |
||
| 45 | |=.*urlParams*|=.+|Список параметров вызова следующей функции| |
||
| 46 | |||
| 47 | fn1. В одну группу каталогов может входить несколько брендов, объединенных нами по известным только нам признакам. Используются исключительно для биллинга, выбор нужных групп происходит на стадии подключения API ключа. |
||
| 48 | |||
| 49 | fn2. Исторически сложившееся название "регион" может регионом и не являться. В частности, один из регионов называется "Мотокаталоги". |
||
| 50 | |||
| 51 | --- |
||
| 52 | |||
| 53 | h2. Пример возвращаемых данных |
||
| 54 | |||
| 55 | --- |
||
| 56 | |||
| 57 | <pre><code class="ruby"> |
||
| 58 | "data": [ |
||
| 59 | { |
||
| 60 | "values": [ |
||
| 61 | { |
||
| 62 | "id": 56, |
||
| 63 | "name": "ABARTH", |
||
| 64 | "groupId": 54, |
||
| 65 | "groupName": "FIAT", |
||
| 66 | "regionId": 3, |
||
| 67 | "regionName": "Европа", |
||
| 68 | "brandLatestApiVersion": "2.0", |
||
| 69 | "urlParams": { |
||
| 70 | "brand": "abarth" |
||
| 71 | } |
||
| 72 | }, |
||
| 73 | |||
| 74 | ... |
||
| 75 | |||
| 76 | { |
||
| 77 | "id": 13, |
||
| 78 | "name": "VW", |
||
| 79 | "groupId": 2, |
||
| 80 | "groupName": "VAG", |
||
| 81 | "regionId": 3, |
||
| 82 | "regionName": "Европа", |
||
| 83 | "brandLatestApiVersion": "2.0", |
||
| 84 | "urlParams": { |
||
| 85 | "brand": "vw" |
||
| 86 | } |
||
| 87 | }, |
||
| 88 | { |
||
| 89 | "id": 70, |
||
| 90 | "name": "ZX", |
||
| 91 | "groupId": 63, |
||
| 92 | "groupName": "BYD, FAW, ZX", |
||
| 93 | "regionId": 1, |
||
| 94 | "regionName": "Китай", |
||
| 95 | "brandLatestApiVersion": "2.0", |
||
| 96 | "urlParams": { |
||
| 97 | "brand": "zx" |
||
| 98 | } |
||
| 99 | } |
||
| 100 | ], |
||
| 101 | "format": "ifList", |
||
| 102 | "listItemFormat": [ |
||
| 103 | { |
||
| 104 | "type": "ifLink", |
||
| 105 | "caption": "{name}" |
||
| 106 | } |
||
| 107 | ] |
||
| 108 | } |
||
| 109 | ] |
||
| 110 | </code></pre> |