Difference between revisions of "Шаблон:OEM:The returned data for Catalog/en"

From Laximo
Jump to: navigation, search
Line 5: Line 5:
 
|-
 
|-
 
! Parameter   
 
! Parameter   
! Mandatory
+
! Obligatory
 
! Description
 
! Description
 
|-
 
|-

Revision as of 10:09, 5 December 2018

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 - Whether the catalog supports vehicle identification by parameters. Necessary for operations GetWizard2/FindVehicleByWizard2. Use features/feature with the name wizardsearch instead of it
supportquickgroups - Whether the catalog supports vehicle identification by groups. Use features/feature with the name quickgroups instead of it
vinexample + Sample of VIN code for the catalog given. Use features/feature with the attribute example instead of it
frameexample + Sample of code and frame number for the catalog given. Use features/feature with the nthe attribute example instead of it

Секция features содержит перечень стандартных функций, которые поддерживаются системой среди них:

  • vinsearch - поиск по вин с помощью функции FindVehicleByVin
  • framesearch - поиск по коду и номеру кузова с помощью функции FindVehicleByFrame
  • wizardsearch2 - поиск автомобиля по параметра с помощью функций GetWizard2, FindVehicleByWizard2, GetWizardNextStep
  • quickgroups - поиск запчастей по коду группы с помощью функций ListQuickGroup, ListQuickDetail

Секция extensions/operations содержит перечень дополнительных операций, поддерживаемых в данном каталоге.

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.