Проект

Общее

Профиль

GetModelsVAG » История » Версия 5

Артем, 22.10.2016 13:33

1 1 Артем
h1. getModels
2
3
4
5
h2. Описание метода
6
7
---
8
9
p(. Метод возвращает список моделей автомобиля для рынка
10
11
h2. Параметры вызова
12
13
---
14
15
p(. 
16
|=.параметр|=.обязательный|=.описание|
17
|*apiKey*|=.+|Ваш ключ доступа к API|
18 4 Артем
|*apiVersion*|=.+|Версия API|
19 1 Артем
|*brand*|=.+|audi|
20
|*function*|=.+|getModels|
21
|*vin*|=.-|vin-номер автомобиля|
22
|*market*|=.+|ID рынка|
23
|*language*|=.-|Язык каталога|
24
25
26
h2. Возвращаемые данные
27
28
---
29
30
p(. Метод возвращает массив данных models.
31
32
Массив параметров модели состоит из следующих элементов: 
33
 
34
|*name*|Полное название модели|
35
|*сode*|Код модели|
36
|*startDate*|Дата начала производства (в формате ГГГГ)|
37
|*endDate*|Дата окончания производства (в формате ГГГГ)|
38
|*productionCode*|Код производителя|
39
|*years*|Массив, содержащий года выпуска автомобиля|
40
41 3 Артем
Каждый элемент массива *years* содержит элементы, состоящие из следующих структур:
42 2 Артем
43 1 Артем
|*year*|Год|
44
|*comment*|Комментарий к году выпуска|
45
|*function*|Название метода следующего этапа поиска|
46
|*urlParams*|Параметры вызова следующего метода|
47 5 Артем
48
49
h2. Пример возвращаемых API данных:
50
51
---
52
53
!http://static.ilcats.ru/images/helpsystem/catalogsApi/helpVagGetModels1.png!