Template:OEM:The returned data for Catalog

From Laximo
Revision as of 10:20, 5 December 2018 by Kuksina.j (Talk | contribs)

Jump to: navigation, search
Other languages:
English • ‎русский
Parameter Obligatory Description
code + Unique catalog code. The given code must be used for further access to the service.
icon + Name of the catalog icon, "toyota.png"
brand + Name of the brand (catalog) in capital letters
version + Catalog version, for example, "08.2009"
name + Catalog name, if possible, on the requested language
supportframesearch - Whether the catalog supports vehicle identification by frame. Typically used for the Japanese market. Use features/feature с именем framesearch instead of it.
supportvinsearch - Whether the catalog supports vehicle identification by VIN. Use features/feature with the name vinsearch instead of it
supportparameteridentification2 - Поддерживает ли каталог идентификацию автомобилей по параметрам.

Необходим для работы функций GetWizard2/FindVehicleByWizard2 Используйте featrures/feature с именем wizardsearch взамен

supportquickgroups - Поддерживает ли каталог быстрый поиск запчастей по группам

Используйте featrures/feature с именем quickgroups взамен

vinexample + Пример VIN кода для данного каталога

Используйте featrures/feature с атрибутом example взамен

frameexample + Sample of code and frame number for the catalog given. Use features/feature with the nthe attribute example instead of it

The features section contains a list of standard options that are supported by the system among them:

  • vinsearch - search by VIN by the FindVehicleByVin
  • framesearch - search by frame number and code by the FindVehicleByFrame
  • wizardsearch2 - the vehicle search by parameters by the GetWizard2, FindVehicleByWizard2, GetWizardNextStep
  • quickgroups - search of auto parts by group code by the ListQuickGroup, ListQuickDetail

The extensions/operations section contains a list of additional operations supported in the catalog.

Parameter Obligatory Description
name + Name of operation. It must be transferred to the ExecCustomOperation.
kind + Operation type. At the current moment only the vehicle search is supported (search_vehicle).
description + Name of an operation in the required language

Секция extensions/operations/operation/params/param содержит перечень параметров операции.

Parameter Obligatory Description
name + Parameter name
pattern + Regular expression, which allows to verify the accuracy of data input of the user.
description + Name of an operation in the required language

Warning.gif Note! Given list of the returning data can be extended anytime, while improving and updating the Web service.

Information.gif - The outdated parameters are indicated by red color.