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 [2019/09/10 15:23] rihad [The XML elements in detail] |
integration_documentation:response_xml [2020/02/20 14:04] florian [Basic structure of the XML tree] |
||
---|---|---|---|
Line 20: | Line 20: | ||
* ''[[#filter]]'' | * ''[[#filter]]'' | ||
* ... | * ... | ||
- | * ''[[#landingpage]]'' | + | * ''[[#landingPage]]'' |
* ''[[#promotion]]'' | * ''[[#promotion]]'' | ||
---- | ---- | ||
+ | |||
+ | See our [[https://github.com/findologic/xml-response-schema/blob/v2.1.0/schema.xsd|xsd scheme]] for further information. | ||
==== The XML elements in detail ==== | ==== The XML elements in detail ==== | ||
Line 162: | Line 164: | ||
* ''count'' | * ''count'' | ||
* indicates the total number of elements to be displayed | * indicates the total number of elements to be displayed | ||
- | |||
- | ---- | ||
- | |||
- | === <searchedWordCount/> === | ||
- | |||
- | Indicates the number of searched words from the query. | ||
- | |||
- | ---- | ||
- | |||
- | === <foundWordCount/> === | ||
- | |||
- | Indicates the number of found words from the query. If no results could be found for the complete query, **''<foundWordCount/>''** is correspondingly reduced to the number of words for which result could be found. ((''foundWordCount'' has currently no function)) | ||
---- | ---- | ||
Line 184: | Line 174: | ||
<count>2</count> | <count>2</count> | ||
</results> | </results> | ||
- | | + | |
---- | ---- | ||
Line 201: | Line 191: | ||
<product id="123" direct="2"/> | <product id="123" direct="2"/> | ||
</products> | </products> | ||
- | | + | |
---- | ---- | ||
Line 243: | Line 233: | ||
<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 264: | Line 271: | ||
</items> | </items> | ||
</filter> | </filter> | ||
- | | + | |
---- | ---- | ||
Line 293: | Line 300: | ||
* ''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 389: | Line 396: | ||
\\ | \\ | ||
- | == <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 410: | Line 417: | ||
</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 527: | Line 538: | ||
</products> | </products> | ||
<filters> | <filters> | ||
+ | <main> | ||
<filter> | <filter> | ||
<name>cat</name> | <name>cat</name> | ||
Line 558: | Line 570: | ||
</item> | </item> | ||
</filter> | </filter> | ||
+ | </main> | ||
+ | <other> | ||
<filter> | <filter> | ||
<select>single</select> | <select>single</select> | ||
Line 583: | Line 597: | ||
</items> | </items> | ||
</filter> | </filter> | ||
+ | </other> | ||
</filters> | </filters> | ||
</searchResult> | </searchResult> |