Web service API

How to use PageSeeder's Web service API

get group facet

/groups/{group}/facet [GET]

com.pageseeder.search.GetFacet

Description

Returns the facets for a specific field in the index.

Parameters

NameDescriptionRequiredTypeDefault value
field A valid index field yes string

See Index for index fields available.

Permission

Undocumented permissions requirements.

Response

When the field is valid, the XML returned is:

<facet name="[field name]"
       type="field"
       computed="true"
       total="[total]">
   <term field="[field name]"
         text="[term]"
         cardinality="[occurrences]"/>
   ...
</facet>

If field is invalid, return:

<facet name="pd" type="field" computed="true" total="0"/>

Error Handling

CodeCause / Description
0x0201Missing required field.

Created on , last edited on