Ready to Learn?Ex Libris products all provide open APIs

Facet Field Parameter

Syntax

The facet field parameter uses the following syntax:

s.ff=<facetField>, <combineMode>[, <pageNumber or whiteList>, <pageSize>]

A query string may contain many s.ff parameters. The default value for pageNumber is 1, if unspecified. The default value for pageSize is 10, if unspecified.

A whiteList has the form value1:value2:.... It specifies a set of facet values that are to be returned whether or not their counts are in the top pageSize, provided only that their counts are non-zero.

Function

The facet field parameter requests facet counts for a given facet field to be returned with results. This command can only be used on facetable fields.

Example - Using the facet field parameter

This query string returns facet counts for the ContentType field with the results:

s.ff=ContentType,or,1,15

Example - Using the facet field parameter with a white list

This query string returns facet counts for the ContentType field including counts for Journal and eJournal, unless their counts are zero:

s.ff=ContentType,or,Journal:eJournal,5