integration_documentation:response_xml
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
integration_documentation:response_xml [2018/05/08 12:28] florian [The XML elements in detail] |
integration_documentation:response_xml [2019/09/11 09:18] rihad [Additional information for users of Smart Did-You-Mean] |
||
|---|---|---|---|
| Line 60: | Line 60: | ||
| <limit first="0" count="10"/> | <limit first="0" count="10"/> | ||
| <queryString>Test</queryString> | <queryString>Test</queryString> | ||
| - | <searchedWordCount>1</searchedWordCount> | ||
| - | <foundWordCount>1</foundWordCount> | ||
| </query> | </query> | ||
| </code> | </code> | ||
| Line 73: | Line 71: | ||
| \\ | \\ | ||
| - | == Did-You-Mean == | + | === Did-You-Mean === |
| A possible alternative to the user’s original query. Results in this case are based on the original query. | A possible alternative to the user’s original query. Results in this case are based on the original query. | ||
| Line 96: | Line 94: | ||
| \\ | \\ | ||
| - | == Improved query == | + | === Improved query === |
| The original query has good results, but there is an alternative query that may be more relevant to the user. | The original query has good results, but there is an alternative query that may be more relevant to the user. | ||
| Line 119: | Line 117: | ||
| \\ | \\ | ||
| - | == Corrected query == | + | === Corrected query === |
| The original query did not yield any results, so the best alternative with results is shown instead. | The original query did not yield any results, so the best alternative with results is shown instead. | ||
| Line 138: | Line 136: | ||
| \\ | \\ | ||
| - | == Forced query == | + | === Forced query === |
| In case the request URL parameter ''forceOriginalQuery=1'' was submitted, Smart Did-You-Mean functionality is disabled, and the search results are based on the user’s query. The response reflects this fact: | In case the request URL parameter ''forceOriginalQuery=1'' was submitted, Smart Did-You-Mean functionality is disabled, and the search results are based on the user’s query. The response reflects this fact: | ||
| Line 186: | Line 184: | ||
| <count>2</count> | <count>2</count> | ||
| </results> | </results> | ||
| - | | + | |
| ---- | ---- | ||
| Line 203: | Line 201: | ||
| <product id="123" direct="2"/> | <product id="123" direct="2"/> | ||
| </products> | </products> | ||
| - | | + | |
| ---- | ---- | ||
| Line 232: | Line 230: | ||
| == <property/> == | == <property/> == | ||
| - | Shows the contents of an [[export_patterns:csv#optional_additional_columns|optional export column.]] | + | Shows the contents of an [[csv_export_documentation:csv_format#optional_additional_columns|optional export column.]] |
| **Attribute:** | **Attribute:** | ||
| Line 245: | Line 243: | ||
| <filters> | <filters> | ||
| - | <filter> | + | <main> |
| + | <filter> | ||
| ... | ... | ||
| - | </filter> | + | </filter> |
| + | </main> | ||
| + | <other> | ||
| + | <filter> | ||
| + | ... | ||
| + | </filter> | ||
| + | </other> | ||
| </filters> | </filters> | ||
| | | ||
| - | \\ | + | === <main/> === |
| - | == <filter/> == | + | Indicates that the respective filter is configurated as main filter in the [[https://secure.findologic.com/login.symfony/web/app.php/shop/filter|customer account]] |
| + | |||
| + | {{:integration_documentation:main-filter.png?|}} | ||
| + | |||
| + | === <other/> === | ||
| + | |||
| + | Indicates that the respective filter is configuratedas other filter in the [[https://secure.findologic.com/login.symfony/web/app.php/shop/filter|customer account]] | ||
| + | |||
| + | {{:integration_documentation:other-filter.png?|}} | ||
| + | |||
| + | === <filter/> === | ||
| Indicates a filter category and contains the various values for this filter category in the ''<items/>'' elements. | Indicates a filter category and contains the various values for this filter category in the ''<items/>'' elements. | ||
| Line 266: | Line 281: | ||
| </items> | </items> | ||
| </filter> | </filter> | ||
| - | | + | |
| ---- | ---- | ||
| Line 295: | Line 310: | ||
| * ''multiple'' | * ''multiple'' | ||
| * Several values can be given for one filter. | * Several values can be given for one filter. | ||
| - | * These are **und**-linked. | + | * These are **and**-linked. |
| * Example: Color filter | * Example: Color filter | ||
| Line 391: | Line 406: | ||
| \\ | \\ | ||
| - | == <item/> == | + | === <item/> === |
| - | Contains further information on this concrete filter. | + | Contains further information on this specific filter. |
| - | <item> | + | <item selected="1"> |
| <name>Subgroup</name> | <name>Subgroup</name> | ||
| <display>Subgroup</display> | <display>Subgroup</display> | ||
| Line 412: | Line 427: | ||
| </items> | </items> | ||
| </item> | </item> | ||
| + | |||
| + | |||
| + | * ''selected'' | ||
| + | * indicates that this filter is selected. | ||
| ''<item/>''-elements can contain further ''<items/>'' in turn. | ''<item/>''-elements can contain further ''<items/>'' in turn. | ||
| Line 529: | Line 548: | ||
| </products> | </products> | ||
| <filters> | <filters> | ||
| + | <main> | ||
| <filter> | <filter> | ||
| <name>cat</name> | <name>cat</name> | ||
| Line 560: | Line 580: | ||
| </item> | </item> | ||
| </filter> | </filter> | ||
| + | </main> | ||
| + | <other> | ||
| <filter> | <filter> | ||
| <select>single</select> | <select>single</select> | ||
| Line 585: | Line 607: | ||
| </items> | </items> | ||
| </filter> | </filter> | ||
| + | </other> | ||
| </filters> | </filters> | ||
| </searchResult> | </searchResult> | ||