Project

General

Profile

Actions

ApiReturnDataStructure » History » Revision 1

Revision 1/2 | Next »
Артем, 05/24/2017 11:41 AM


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

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

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

название элемента значение тип данных Ссылка на описание
stageName Название этапа поиска з/ч в локали запроса Строка
mainMenu Структура, содержащая меню текущего этапа поиска з/ч Массив см. Главное меню
availableLanguages Структура, содержащая доступные языки каталога Массив см. Языки каталога
vinSearchParameters Параметры запроса по VIN или FRAME Массив см. Параметры запроса по ВИН
siteLabels Термины (метки, слова), которые могут быть использованы для отображения в локали каталога Массив1
serverInfo Служебная информация Массив
data Данные текущего этапа поиска Массив см. Формат основных данных

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

Updated by Артем over 4 years ago · 1 revisions