Skip to main content

 Services

Web services from /about to /webhooks

group autocomplete

/groups/{group}/autocomplete [GET]

com.pageseeder.search.AutoComplete

Description

Autocomplete the specified term in the group.

This service returns the list of terms that complete the specified prefix. If no prefixed terms are found, it returns similar terms.

Parameters

NameDescriptionRequiredTypeDefault
termThe term to autocomplete, effectively a prefix for possible termsyesstring
fieldsComma-separated list of index fields to look for terms innostringspstitle,pscontent
max-termsThe maximum number of terms to returnnointeger20
prefix-only
Whether to only match prefixes, not similar termsnoboolean
false

Permission

This service is restricted to guest and higher.

Response

Example XML output:

<autocomplete term="test">
  <term field="pstitle" text="test1" prefix="true"/>
  <term field="pstitle" text="test2" prefix="true"/>
  <term field="pscontent" text="testable" prefix="true"/>
  <term field="pscontent" text="tested" prefix="true"/>
  ...
</autocomplete>

Error Handling

No specific errors expected for this service.

Created on , last edited on