ApiReturnDataStructure » История » Версия 2
Артем, 28.02.2019 10:22
| 1 | 1 | Артем | h1. Структура возвращаемых АПИ данных. |
|---|---|---|---|
| 2 | |||
| 3 | АПИ каталогов возвращает данные в формате json. Здесь и далее по тексту возвращаемые данные называются *массив данных* или просто *массив* или *данные*. |
||
| 4 | |||
| 5 | 2 | Артем | Любой метод АПИ, за исключением методов [[Метод_getBrands|getBrands]] и [[Метод_getVin|getVin]], возвращает следующий массив данных: |
| 6 | 1 | Артем | |
| 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. Линейный массив с элементами вида *Идентификатор = название* в локали каталога. |