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 the search is not performed and only the facets for the search are returned.

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

Parameters

Name Description Required Type Default value
facets A comma-separated list of fields to use as facets no strings
facetsize The max number of facet values to load (max 1000) no integer 10
filters A comma-separated list of field:term pairs to use as filters no strings
flexiblefacets A comma-separated list of fields to use as flexible facets no strings
question The question to search for no string
questionfields A comma-separated list of fields to search the question in no strings pstitle,pscontent
ranges A comma-separated list of range searches no strings

Permission

Undocumented permissions requirements.

Response

The XML response is:

<facets>
  ...
</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