Integration von Suggest per XML

Diese Rückgabe ist ebenfalls unter Suggest.ff erreichbar, es muss jedoch beim Aufruf der Schnittstelle der Parameter format=xml mitgegeben werden.

$stringEscapeUtils.escapeHtml($body)

Die Rückgabe hat folgenden Aufbau:

<ff xsi:noNamespaceSchemaLocation="schema/7.2/ffsuggest.xsd">
  <suggest nr="0" query="Helm für Kinder" hitcount="206" type="category" imageUrl="helm_kids_medium.jpg">
    <attributes>
      <attribute name="sourceField">category3</attribute>
    </attributes>
    <searchParams>...searchParams url...</searchParams>
  </suggest>
  <suggest nr="1" query="helm" hitcount="1281" type="searchTerm">
    <searchParams>...searchParams url...</searchParams>
  </suggest>
...
</ff>

Jedes suggest-Tag der Rückgabe steht für einen Suchvorschlag. Das Attribut nr ist ein Index, query enthält den Suchvorschlagstext, hitcount beschreibt die Anzahl der zu erwartenden Treffer und type enthält die Vorschlagstypenbezeichnung. Das Attribut imageUrl ist optional und nur vorhanden, wenn es zu dem Vorschlag ein Vorschaubild gibt, dann ist hier der Link zum Bild enthalten. Der Wert von hitcount kann 0 sein, wenn keine Trefferanzahl aus den Logfiles entnommen oder berechnet wurde. Im searchParams-Tag ist die URL enthalten, die bei Auswahl des Vorschlags angesprungen werden sollte.

Suchvorschläge können zusätzliche Informationen enthalten, einige werden per Standard geliefert, andere können auf Kundenwunsch eingefügt werden. Jedes Zusatzattribut wird als attribute-Tag innerhalb von attributes zurückgegeben, sollte es kein Attribut geben, so fehlen die Tags. Ein Attribut besteht aus einem Attributsnamen (name-Attribut des Tags) und dessen Wert, welcher als Tag-Wert übergeben wird.