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:24] florian [<limit/>] |
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 172: | Line 176: | ||
| Provides information on the query output. | Provides information on the query output. | ||
| - | <results> | + | <code xml><results> |
| <count>2</count> | <count>2</count> | ||
| - | </results> | + | </results></code> |
| ---- | ---- | ||
| Line 188: | Line 192: | ||
| Indicates the query output of the products found. Depending on the values of ''<first/>''- and ''<count/>''-this may include only a partial range of the entire query output. | Indicates the query output of the products found. Depending on the values of ''<first/>''- and ''<count/>''-this may include only a partial range of the entire query output. | ||
| - | <products> | + | <code xml><products> |
| - | <product id="666" direct="1"/> | + | <product id="666" relevance="15.265"> |
| - | <product id="123" direct="2"/> | + | <product id="123" relevance="14.361"> |
| - | </products> | + | </products></code> |
| ---- | ---- | ||
| Line 197: | Line 201: | ||
| === <product/> === | === <product/> === | ||
| - | <product id="123" direct="2"> | + | <code xml><product id="123" relevance="14.361"> |
| <properties> | <properties> | ||
| ... | ... | ||
| </properties> | </properties> | ||
| - | </product> | + | </product></code> |
| **Attributes:** | **Attributes:** | ||
| * ''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. |
| ---- | ---- | ||
| - | ==== <properties/> ==== | + | === <properties/> === |
| - | <properties> | + | <code xml><properties> |
| <property name="propertyName">propertyValue2</property> | <property name="propertyName">propertyValue2</property> | ||
| - | </properties> | + | </properties></code> |
| | | ||
| \\ | \\ | ||
| Line 221: | Line 225: | ||
| === <property/> === | === <property/> === | ||
| - | Shows the contents of an [[csv_export_documentation:csv_format#optional_additional_columns|optional export column.]]. | + | Shows the contents of the properties that have been imported. |
| **Attributes:** | **Attributes:** | ||
| Line 262: | Line 266: | ||
| ---- | ---- | ||
| - | ==== <filter/> ==== | + | === <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 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> |