Skip to main content

 Web service API

How to use PageSeeder's Web service API

group search facets

/groups/{group}/search/facets [GET]

com.pageseeder.search.GetFacets

Description

Get search facets for a single group.

This service does the same as the group search but only the facets for the search are returned.

For details see Service: /groups/{group}/search [GET].

Parameters

NameDescriptionRequiredTypeDefault value
facetsA comma-separated list of fields to use as facetsnostrings
facetsizeThe max number of facet values to load (ignored if larger than global property maxFacetSize - default 100)nointeger10
filtersA comma-separated list of field:term pairs to use as filtersnostrings
flexiblefacetsA comma-separated list of fields to use as flexible facetsnostrings
questionThe question to search fornostring
questionfieldsA comma-separated list of fields to search the question innostringspstitle,pscontent
rangesA comma-separated list of range searchesnostrings

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

The XML response is:

<facets indexes="[comma separated group IDs]" [warning=""]>
  ...
</facets>

For details see Service: /groups/{group}/search [GET].

Error Handling

0x1501 If there is an invalid group specified
0x1505 If the facet size specified is bigger than the global property for face size ( maxFacetSize)
0x1506 If a numeric field is specified as a facet
Created on , last edited on