Проект

Общее

Профиль

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

Артем, 22.10.2016 14:33

1 1 Артем
h1. getParts
2
3
h2. Описание метода
4
5
---
6
7
p(. Метод возвращает список запчастей для выбранной подгруппы
8
9
h2. Параметры вызова
10
11
---
12
13
p(. 
14
|=.параметр|=.обязательный|=.описание|
15
|*apiKey*|=.+|Ваш ключ доступа к API|
16 2 Артем
|*apiVersion*|=.+|Версия API|
17 1 Артем
|*brand*|=.+|kia|
18
|*function*|=.+|getGroups|
19
|*vin*|=.-|vin-номер автомобиля|
20
|*market*|=.+|ID рынка|
21
|*model*|=.+|ID модели|
22
|*modif*|=.-|Список параметров модификации (комплектации) автомобиля|
23
|*group*|=.+|ID группы|
24
|*subgroup*|=.+|ID подгруппы|
25
|*language*|=.-|Язык каталога|
26
27
28
h2. Возвращаемые данные
29
30
---
31
32
p(. Метод возвращает 3 массива данных:
33
34
h3. 1) Массив parts, содержащий список всех запчастей выбранной подгруппы з/ч:
35
 
36
 
37
|*id*|ID запчасти|
38
|*callout*|Номер на изображении|
39
|*calloutText*|Текст номера на изображении|
40
|*name*|Название запчасти|
41
|*number*|Номер(артикул) запчасти|
42 6 Артем
|*replaced*|Признак замены запчасти (0 - не заменялся/1 - заменялся)|
43
|*usage*|Применяемость з/ч|
44
|*comment*|Комментарий к з/ч|
45
|*images*|Изображение з/ч|
46
|*startDate*|Дата начала применения з/ч в формате YYYYMMDD|
47
|*endDate*|Дата окончания применения з/ч в формате YYYYMMDD|
48 1 Артем
|*qty*|Количество используемых в узле запчастей|
49 6 Артем
|*illustrations*|Номер связанного изображения (подгруппы). Массив из двух элементов, *imageName* - номер подгруппы и *imagePos* - номер позиции на соотв. изображении|
50 1 Артем
51 6 Артем
52 1 Артем
h3. 2) Массив images, содержащий список изображений выбранной подгруппы з/ч. Каждый элемент в свою очередь состоит из массива:
53
54
 
55 4 Артем
|*filename*|Имя файла с изображением узла|
56
|*callouts*|Массив координат позиции на картинке вида callout->координаты|
57 1 Артем
|*-ImagePos-*|Не используется|
58
59 6 Артем
Координаты позиции - массив координат вида (x1,y1),(x2,y2) и т.п. Каждая координата - левый-верхний угол соответствующего региона изображения.
60 1 Артем
61
62
Полная ссылка на изображения выглядит, например, http://images.neoriginal.ru/getImage.php?catalog=kia&filename=0LBCDB02/661511.png&scale=75&hash=9e5f1b07f9375fc1ee5c0f2818129310.
63
64
Хеш изображения можно получить, вызвав метод *getImageHash* API сайта. Также Вы можете использовать свой поддомен вида images.ВашСайт.ru (см. [[common_documentation:%D0%9E%D0%B1%D1%89%D0%B0%D1%8F_%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D1%8F|"Общая информация"]])
65
66
h3. 3) Массив linkedGroups, содержащий список подгрупп, связанных с выбранной подгруппой з/ч. Каждый элемент массива, это в свою очередь массив:
67
68
|*group*|ID группы запчастей|
69
|*subgroup*|ID подгруппы запчастей|
70
|*name*|Название подгруппы запчастей|
71
|*callout*|Номер на изображении|
72
|*calloutText*|Текст номера на изображении|