Skip to main content

 Web service API

How to use PageSeeder's Web service API

server autocomplete

/members/{member}/autocomplete [GET]

com.pageseeder.search.AutoComplete

Description

Returns the list of terms to auto-complete a field or set of fields.

Parameters

NameDescriptionRequiredTypeDefault value
fieldsA comma-separated list of fields to search innostringspstitle,pscontent
max-termsThe maximum number of terms to returnnoint20
prefix-onlyWhether to only match prefixes, not similar termsnobooleanfalse
termThe term to auto completeyesstring
urls-onlyWhether to only search URLsnobooleanfalse

Permission

Restricted to the member themselves or administrator.

Response

<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 generator.

Created on , last edited on