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
integration_documentation:response_xml [2020/02/20 14:34]
florian [Example]
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 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.
  
 ---- ----