Web service API

How to use PageSeeder's Web service API

autocomplete group field

/groups/{group}/autocomplete/{field} [GET]

com.pageseeder.search.AutoComplete

This service is deprecated since version 5.9400

Description

Deprecation warning!

This service is now deprecated please use Service: /groups/{group}/autocomplete [GET] instead.

Autocomplete for a specific field

Returns the list of terms that auto-complete the prefix from terms in the field specified in the URL.

Parameters

NameDescriptionRequiredTypeDefault value
termThe term to autocomplete, effectively a prefix for possible termsyesstring
max-termsThe maximum number of terms to returnnointeger20

Permission

Undocumented permissions requirements.

Response

Example XML output:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on