integration_documentation:response_xml

integration_documentation:response_xml

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
integration_documentation:response_xml [2020/02/20 14:31]
florian [<products/>]
integration_documentation:response_xml [2020/02/25 11:28]
florian
Line 3: Line 3:
 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>​
  
 ==== Basic structure of the XML tree ==== ==== Basic structure of the XML tree ====
Line 25: Line 26:
  
 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 521: Line 523:
 ==== 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 540:
     </​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 566:
                 <​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 611:
      </​other>​      </​other>​
     </​filters>​     </​filters>​
-  </​searchResult>​+  </​searchResult></​code>