| Параметр | Обязательный | Описание |
|---|---|---|
| catalog | + | Уникальный код каталога. |
| Параметр | Описание |
|---|---|
| name | Наименование каталога, по возможности, на запрашиваемом языке |
| code | Уникальный код каталога. Данный код необходимо использовать для дальнейших обращений к сервису. |
| brand | Название бренда (каталога) большими буквами |
| features | Содержит перечень стандартных функций, которые поддерживаются системой. |
| operations | Cодержит перечень дополнительных операций, поддерживаемых в данном каталоге. |
Секция features содержит:
Секция operations содержит:
💡 Обратите внимание! Данные списков features и operations могут быть дополнены в любой момент, в рамках работ по улучшению и обновлению веб-сервиса.
/getCatalogInfo?catalog=SCANIA202010
{
"name": "Scania",
"code": "SCANIA202010",
"brand": "SCANIA",
"icon": "scania.png",
"features": [
{
"name": "vinsearch",
"example": "XLER4X20004490991"
},
{
"name": "wizardsearch2"
},
{
"name": "quickgroups"
},
{
"name": "detailapplicability"
},
{
"name": "fulltextsearch"
}
],
"operations": [
{
"name": "findByChassisNumber",
"kind": "search_vehicle",
"description": "Search by chassis",
"fields": [
{
"name": "chassis",
"pattern": "[0-9]{7}",
"description": "Chassis No"
}
]
},
{
"name": "findByEngineNumber",
"kind": "search_vehicle",
"description": "Search by engine number",
"fields": [
{
"name": "engineNo",
"pattern": "[A-Z0-9]{7}",
"description": "Engine number"
}
]
}
]
}
Параметры функции
| Параметр | Обязательный | Описание |
|---|---|---|
| Locale | + | Язык, на котором предпочтительно получить данные |
| Catalog | + | Код каталога, берется из списка каталогов |
| ssd | - | Данные сервера |
| Параметр | Обязательный | Описание |
|---|---|---|
| code | + | Уникальный код каталога. Данный код необходимо использовать для дальнейших обращений к сервису. |
| brand | + | Название бренда (каталога) большими буквами |
| name | + | Наименование каталога, по возможности, на запрашиваемом языке |
Секция features содержит перечень стандартных функций, которые поддерживаются системой среди них:
Секция extensions/operations содержит перечень дополнительных операций, поддерживаемых в данном каталоге.
| Параметр | Обязательный | Описание |
|---|---|---|
| name | + | Имя операции. Должно быть передано в функцию ExecCustomOperation |
| kind | + | Тип операции. На текущий момент поддерживается только поиск автомобилей (search_vehicle) |
| description | + | Наименование операции на запрошенном языке |
| example | + | Примеры возможных дополнительных способов поиска автомобиля |
💡 Обратите внимание! Данные списков features и operations могут быть дополнены в любой момент, в рамках работ по улучшению и обновлению веб-сервиса.
Пример запроса
GetCatalogInfo:Locale=ru_RU|Catalog=SCANIA202010|ssd=
<response>
<GetCatalogInfo>
<row brand="SCANIA" code="SCANIA202010" icon="scania.png" name="Scania" supportdetailapplicability="true" supportparameteridentification2="true" supportquickgroups="true" supportvinsearch="true" vinexample="XLER4X20004490991">
<features>
<feature example="XLER4X20004490991" name="vinsearch"/>
<feature name="wizardsearch2"/>
<feature name="quickgroups"/>
<feature name="detailapplicability"/>
<feature name="fulltextsearch"/>
</features>
<extensions>
<operations>
<operation description="Поиск по номеру двигателя" kind="search_vehicle" name="findByEngineNumber">
<field description="Номер двигателя" example="6189729" name="engineNo" pattern="[A-Z0-9]{7}"/>
</operation>
<operation description="Поиск по номеру шасси" kind="search_vehicle" name="findByChassisNumber">
<field description="Номер шасси" example="4490991" name="chassis" pattern="[0-9]{7}"/>
</operation>
</operations>
</extensions>
</row>
</GetCatalogInfo>
</response>