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 | ||
integration_documentation:response_xml [2020/02/20 14:28] florian [<products/>] |
integration_documentation:response_xml [2020/06/16 15:34] (current) amil |
||
---|---|---|---|
Line 1: | Line 1: | ||
===== Response: XML ===== | ===== Response: XML ===== | ||
- | The response format can be set by FINDOLOGIC only. If the XML response format is used, please refer to the following documentation. | + | The response format can be set by Findologic only. If the XML response format is used, please refer to the following documentation. |
+ | <note tip>Our library helps requesting the Findologic API and also getting the data from the response and mapping it to corresponding objects. Read more at https://github.com/findologic/findologic-api </note> | ||
+ | |||
+ | <note tip>You can also find a detailed API specification of the XML 2.1 response on our [[https://service.findologic.com/ps/centralized-frontend/spec/|Findologic API Spec page]].</note> | ||
==== Basic structure of the XML tree ==== | ==== Basic structure of the XML tree ==== | ||
Line 25: | Line 28: | ||
See our [[https://github.com/findologic/xml-response-schema/blob/v2.1.0/schema.xsd|xsd scheme]] for further information. | 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 ==== | ||
- | \\ | ||
==== <servers/> ==== | ==== <servers/> ==== | ||
Line 189: | Line 193: | ||
<code xml><products> | <code xml><products> | ||
- | <product id="666"/> | + | <product id="666" relevance="15.265"> |
- | <product id="123"/> | + | <product id="123" relevance="14.361"> |
</products></code> | </products></code> | ||
Line 197: | Line 201: | ||
=== <product/> === | === <product/> === | ||
- | <code xml><product id="123" direct="2"> | + | <code xml><product id="123" relevance="14.361"> |
<properties> | <properties> | ||
... | ... | ||
Line 206: | Line 210: | ||
* ''id'' | * ''id'' | ||
* Indicates the ID of the respective product transmitted in the export. | * Indicates the ID of the respective product transmitted in the export. | ||
- | * ''direct'' | + | * ''relevance'' |
- | * This parameter will continue to be delivered for legacy reasons, but it is always "0". | + | * Indicates the relevance of the respective product. |
---- | ---- | ||
Line 281: | Line 285: | ||
=== <name/> === | === <name/> === | ||
- | The key for this attribute to be submitted to FINDOLOGIC. | + | The key for this attribute to be submitted to Findologic. |
---- | ---- | ||
Line 436: | Line 440: | ||
=== <name/> === | === <name/> === | ||
- | The value for this attribute to be submitted to FINDOLOGIC. | + | The value for this attribute to be submitted to Findologic. |
---- | ---- | ||
Line 448: | Line 452: | ||
=== <weight/> === | === <weight/> === | ||
- | The relevance of the filter((between 0 and 1; with 0, no further filters are applied since the filter applies to all current results; 1 is the maximum relevance, this filter applies to 50% of the results)), in the case of an XML response for FINDOLOGIC Navigation, this value has no significance and should therefore be ignored in the filter output. | + | The relevance of the filter((between 0 and 1; with 0, no further filters are applied since the filter applies to all current results; 1 is the maximum relevance, this filter applies to 50% of the results)), in the case of an XML response for Findologic Navigation, this value has no significance and should therefore be ignored in the filter output. |
---- | ---- | ||
Line 521: | Line 525: | ||
==== Example ==== | ==== Example ==== | ||
- | The following example is fictitious and contains all possible elements at the same time. | + | The following example is fictional and contains all possible elements at the same time. |
- | <searchResult> | + | <code xml><searchResult> |
<servers> | <servers> | ||
- | <frontend>frontend.findologic.com</frontend> | + | <frontend>frontend9.findologic.com</frontend> |
- | <backend>frontend.findologic.com</backend> | + | <backend>backend12.findologic.com</backend> |
</servers> | </servers> | ||
<query> | <query> | ||
<limit first="0" count="10"/> | <limit first="0" count="10"/> | ||
<queryString>Test</queryString> | <queryString>Test</queryString> | ||
- | <searchedWordCount>1</searchedWordCount> | ||
- | <foundWordCount>1</foundWordCount> | ||
</query> | </query> | ||
<landingPage link="http://www.example.com/imprint" /> | <landingPage link="http://www.example.com/imprint" /> | ||
Line 540: | Line 542: | ||
</results> | </results> | ||
<products> | <products> | ||
- | <product id="666" direct="1"/> | + | <product id="666" relevance="15.311"/> |
<properties> | <properties> | ||
<property name="propertyName">propertyValue1</property> | <property name="propertyName">propertyValue1</property> | ||
</properties> | </properties> | ||
- | <product id="123" direct="2"/> | + | <product id="123" relevance="14.363"/> |
<properties> | <properties> | ||
<property name="propertyName">propertyValue2</property> | <property name="propertyName">propertyValue2</property> | ||
Line 566: | Line 568: | ||
<name>Unteruntergruppe</name> | <name>Unteruntergruppe</name> | ||
<weight>0.985228</weight> | <weight>0.985228</weight> | ||
- | <frequency>4</frequency> | + | <frequency type="relative">4</frequency> |
<items> | <items> | ||
... | ... | ||
Line 611: | Line 613: | ||
</other> | </other> | ||
</filters> | </filters> | ||
- | </searchResult> | + | </searchResult></code> |