Web service API

How to use PageSeeder's Web service API

project search

/members/{member}/projects/{group}/search [GET]

com.pageseeder.search.Search

Description

Search multiple groups by question.

This service does the same as the group search but collates the results from multiple groups.

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

The indexes

The current implementation of PageSeeder produces one Lucene index per group.

This service searches every group under the project that the member can access. To narrow the target groups, use the groups parameter with a comma separated list of group names.

Note

Only groups that use the same template as the project will be searched because they use the same index catalog.

Parameters

NameDescriptionRequiredTypeDefault value
facetsA comma-separated list of fields to use as facets.nostrings
facetsizeThe max number of facet values to load (max 1000).nointeger10
filtersA comma-separated list of field:term pairs to use as filters.nostrings
flexiblefacetsA comma-separated list of fields to use as flexible facets.nostrings
fieldsizeMaximum number of characters allowed in a result field (max 10000).nointeger1000
groupsA comma-separated list of group names (only used when there is a project on the request).nostrings
pageThe current page to view.nointeger1
pagesizeHow many results does a page contain.nointeger100
questionThe question to search for.nostring
questionfieldsA comma-separated list of fields to search the question in.nostringspstitle,pscontent
rangesA comma-separated list of range searches.nostrings
searchgroupsIf  'all', then search all groups under the project (administrators only).noenumuser
sortfieldsA comma-separated list of fields to sort the results.nostrings
suggestsizeThe max number of suggestions to load (only for question query).nointeger20

Permission

Permissions requirements to be updated.

Response

The XML response is:

<search>
  <query> ... </query>
  <suggestions> ... </suggestions>
  <facets> ... </facets>
  <results>  ... </results>
</search>

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

Error Handling

CodeCause / Description
0x1501If there is an invalid group specified
0x1502If there are no indexes selected
0x1503If the predicate is not valid
0x1504If a sort field cannot be used for sorting
0x1505If the facet size specified is bigger than the global property for face size ( maxFacetSize)
0x1506If a numeric field is specified as a facet

Created on , last edited on