Проект

Общее

Профиль

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

Артем, 20.10.2016 17:18

1 1 Артем
h1. getVin
2 2 Артем
3 1 Артем
h2. Описание метода
4
5
---
6
7 2 Артем
p(. Метод возвращает параметры автомобиля по его VIN-номеру.
8 1 Артем
9
h2. Параметры вызова
10
11
---
12
13
p(. 
14
|=.параметр|=.обязательный|=.описание|
15
|*apiKey*|=.+|Ваш ключ доступа к API|
16 5 Артем
|*apiVersion*|=.+|Ваш ключ доступа к API|
17 1 Артем
|*brand*|=.+|kia|
18 2 Артем
|*function*|=.+|getVin|
19
|*vin*|=.+|VIN-номер|
20 1 Артем
|*language*|=.-|Язык каталога|
21
22 2 Артем
23 1 Артем
h2. Возвращаемые данные
24
25
---
26
27 2 Артем
p(. Метод возвращает массив vins, каждый элемент которого состоит из следующих элементов:
28 1 Артем
 
29 2 Артем
|*shortDescription*|Сокращенное описание автомобиля|
30
|*description*|Массив параметров автомобиля, элементы массива в виде *название параметра => значение параметра*|
31
|*options*|Массив дополнительных опций, установленных на автомобиле, элементы массива в виде *код опции => название опции*|
32 4 Артем
|*urlParams*|Массив, содежащий данные для перехода в следующий этап поиска|