Project

General

Profile

ApiReturnDataStructure » History » Version 1

Артем, 05/24/2017 11:41 AM

1 1 Артем
h1. Структура возвращаемых АПИ данных.
2
3
АПИ каталогов возвращает данные в формате json. Здесь и далее по тексту возвращаемые данные называются *массив данных* или просто *массив* или *данные*. 
4
5
Любой метод АПИ, за исключением методов, отдельно выделенных на главной странице документации по АПИ (например, getImageHash), возвращает следующий массив данных:
6
7
|*название элемента*|*значение*|*тип данных*|*Ссылка на описание*|
8
|*stageName*|Название этапа поиска з/ч в локали запроса|Строка||
9
|*mainMenu*|Структура, содержащая меню текущего этапа поиска з/ч|Массив|см. [[apiMainMenuDescription|Главное меню]]|
10
|*availableLanguages*|Структура, содержащая доступные языки каталога|Массив|см. [[apiAvailLangDescription|Языки каталога]]|
11
|*vinSearchParameters*|Параметры запроса по VIN или FRAME|Массив|см. [[apiVinParamDescription|Параметры запроса по ВИН]]|
12
|*siteLabels*|Термины (метки, слова), которые могут быть использованы для отображения в локали каталога|Массив[1]||
13
|*serverInfo*|Служебная информация|Массив||
14
|*data*|Данные текущего этапа поиска|Массив|см. [[apiMainDataDescription|Формат основных данных]]|
15
16
fn1. Линейный массив с элементами вида *Идентификатор = название* в локали каталога.