Документация

h1. Метод getBrands

---

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

---

p(. Возвращает список доступных производителей автомобилей.

---

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

---

|=.Параметр|Обязательный|=.Описание|

|=.*function*|=.+|getBrands|

|=.*apiKey*|=.+|API-ключ|

|=.*apiVersion*|=.+|Версия API|

|=.*clientId*|=.+|Ваш ID клиента|

|=.*domain*|=.+|Домен, для которого сгенерирован API-ключ|

---

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

---

http://api.ilcats.ru/?clientId=1234567890&domain=www.ilcats.ru&apiKey=abxxxxxxxxxxxxxxxxxxxx98&apiVersion=2.0&function=getBrands

---

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

---

p(. Метод возвращает массив значений *values* в формате *ifList*, содержащий список брендов.

|=.Название|=.Обязательн.|=.Описание|

|=.*id*|=.+|Числовой ID бренда|

|=.*name*|=.+|Название бренда|

|=.*groupId*|=.+|ID группы каталогов[1]|

|=.*groupName*|=.+|Название группы каталогов|

|=.*regionId*|=.+|ID региона каталогов[2]|

|=.*regionName*|=.+|Название региона каталогов|

|=.*urlParams*|=.+|Список параметров вызова следующей функции|

fn1. В одну группу каталогов может входить несколько брендов, объединенных нами по известным только нам признакам. Используются исключительно для биллинга, выбор нужных групп происходит на стадии подключения API ключа.

fn2. Исторически сложившееся название "регион" может регионом и не являться. В частности, один из регионов называется "Мотокаталоги". 

---

h2. Пример возвращаемых данных

---

<pre><code class="ruby">

"data": [

  {

   "values": [

     {

       "id": 56,

       "name": "ABARTH",

       "groupId": 54,

       "groupName": "FIAT",

       "regionId": 3,

       "regionName": "Европа",

       "brandLatestApiVersion": "2.0",

       "urlParams": {

          "brand": "abarth"

        }

     },

     ...

     {

       "id": 13,

       "name": "VW",

       "groupId": 2,

       "groupName": "VAG",

       "regionId": 3,

       "regionName": "Европа",

       "brandLatestApiVersion": "2.0",

       "urlParams": {

          "brand": "vw"

       }

     },

     {

       "id": 70,

       "name": "ZX",

       "groupId": 63,

       "groupName": "BYD, FAW, ZX",

       "regionId": 1,

       "regionName": "Китай",

       "brandLatestApiVersion": "2.0",

       "urlParams": {

          "brand": "zx"

       }

     }

   ],

   "format": "ifList",

   "listItemFormat": [

       {

         "type": "ifLink",

         "caption": "{name}"

       }

   ]

  }

]

</code></pre>