Документация

h1. Структура возвращаемых АПИ данных.

АПИ каталогов возвращает данные в формате json. Здесь и далее по тексту возвращаемые данные называются *массив данных* или просто *массив* или *данные*. 

Любой метод АПИ, за исключением методов, отдельно выделенных на главной странице документации по АПИ (например, getImageHash), возвращает следующий массив данных:

|*название элемента*|*значение*|*тип данных*|*Ссылка на описание*|

|*stageName*|Название этапа поиска з/ч в локали запроса|Строка||

|*mainMenu*|Структура, содержащая меню текущего этапа поиска з/ч|Массив|см. [[apiMainMenuDescription|Главное меню]]|

|*availableLanguages*|Структура, содержащая доступные языки каталога|Массив|см. [[apiAvailLangDescription|Языки каталога]]|

|*vinSearchParameters*|Параметры запроса по VIN или FRAME|Массив|см. [[apiVinParamDescription|Параметры запроса по ВИН]]|

|*siteLabels*|Термины (метки, слова), которые могут быть использованы для отображения в локали каталога|Массив[1]||

|*serverInfo*|Служебная информация|Массив||

|*data*|Данные текущего этапа поиска|Массив|см. [[apiMainDataDescription|Формат основных данных]]|

fn1. Линейный массив с элементами вида *Идентификатор = название* в локали каталога.