GetPartsVAG » История » Версия 3
Артем, 22.10.2016 12:38
| 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 | |*imagescale*|=.-|Масштаб изображений| |
||
| 26 | |*language*|=.-|Язык каталога| |
||
| 27 | |||
| 28 | |||
| 29 | h2. Возвращаемые данные |
||
| 30 | |||
| 31 | --- |
||
| 32 | |||
| 33 | p(. Метод возвращает 3 массива данных: |
||
| 34 | |||
| 35 | h3. 1) Массив parts, содержащий список всех запчастей выбранной подгруппы з/ч: |
||
| 36 | |||
| 37 | |||
| 38 | |*id*|ID запчасти| |
||
| 39 | |*callout*|Номер на изображении| |
||
| 40 | |*calloutText*|Текст номера на изображении| |
||
| 41 | |*name*|Название запчасти| |
||
| 42 | |*number*|Номер(артикул) запчасти| |
||
| 43 | |*replaced*|Номер(артикул) замены запчасти| |
||
| 44 | |*replaceType*|Тип замены запчасти| |
||
| 45 | |*additionalInfo*|Дополнительная информация о з/ч| |
||
| 46 | |*dateStart*|Дата начала применения з/ч в формате YYYYMMDD| |
||
| 47 | |*dateEnd*|Дата окончания применения з/ч в формате YYYYMMDD| |
||
| 48 | |*qty*|Количество используемых в узле запчастей| |
||
| 49 | |*usage*|Массив описания применяемости. Может (необязательно) состоять их двух массивов, with и without (в первом - опции автомобиля, с которыми деталь применяется, во-втором список опций авто, с которыми деталь не применяется). Элементы масивов: *id* - ID параметра применяемости и *value* - значение параметра применяемости в локали каталога| |
||
| 50 | |||
| 51 | h3. 2) Массив images, содержащий список изображений выбранной подгруппы з/ч. Каждый элемент в свою очередь состоит из массива: |
||
| 52 | |||
| 53 | |||
| 54 | |*Filename*|Имя файла с изображением узла| |
||
| 55 | |*Callouts*|Массив координат позиции на картинке вида callout->координаты| |
||
| 56 | |*-ImagePos-*|Не используется| |
||
| 57 | |||
| 58 | Координаты позиции - массив координат вида (x1,y1),(x2,y2) и т.п. Каждая координата - левый-верхний угол соответствующего регина изображения. |
||
| 59 | |||
| 60 | |||
| 61 | Полная ссылка на изображения выглядит, например, http://images.neoriginal.ru/getImage.php?catalog=kia&filename=0LBCDB02/661511.png&scale=75&hash=9e5f1b07f9375fc1ee5c0f2818129310. |
||
| 62 | |||
| 63 | Хеш изображения можно получить, вызвав метод *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|"Общая информация"]]) |
||
| 64 | |||
| 65 | h3. 3) Массив linkedGroups, содержащий список подгрупп, связанных с выбранной подгруппой з/ч. Каждый элемент массива, это в свою очередь массив: |
||
| 66 | |||
| 67 | |*group*|ID группы запчастей| |
||
| 68 | |*subgroup*|ID подгруппы запчастей| |
||
| 69 | |*name*|Название подгруппы запчастей| |
||
| 70 | |*callout*|Номер на изображении| |
||
| 71 | |*calloutText*|Текст номера на изображении| |