Query Response Field

The query field will be populated for all queries except when the HTTP status is 400 or 500. The query contains the following 18 fields:

  • queryString - the current query string, after commands were applied
  • pageNumber - the current page number
  • pageSize - the current page sizes
  • isHighlightingEnabled - whether or not highlighting is currently turned on
  • highlightStartDelimiter - the current highlight start delimiter
  • highlightEndDelimiter - the current highlight end delimiter
  • isDidYouMeanEnabled - whether or not did you mean is currently turned on
  • isDebugEnabled - whether or not debug is currently turned on
  • isHoldingsOnlyEnabled - whether or not holdings only mode is currently turned on
  • textQueries - list of the textQuery items in the current query
  • textFilters - list of the textFilter items in the current query
  • rangeFilters - list of the rangeFilter items in the current query
  • facetValueFilters - list of the facetValueFilter items in the current query
  • facetValueGroupFilters - list of the facetValueGroupFilter items in the current query
  • facetFields - list of the facetField items in the current query
  • rangeFacetFields - list of the rangeFacetField items in the current query
  • sort - the sort order of the current query

Example - A query element in XML format

<query
 queryString="s.fvgf%3A1=ContentType%2Cor%2CBook%2CJournal+Article&amp;s.hs=%3Ch%3E&amp;s.ho=true&amp;s.fq=Title%3Arain&amp;s.sort=PublicationDate%3Adesc&amp;s.rff=PublicationDate%2C1990%3A2000&amp;s.ps=10&amp;s.debug=false&amp;s.dym=true&amp;s.pn=1&amp;s.rf=PublicationDate%2C1990%3A2000&amp;s.ff=ContentType%2Cor%2C1%2C1&amp;s.hl=true&amp;s.q=forests&amp;s.he=%3C%2Fh%3E&amp;s.fvf=ContentType%2CJournal+Article%2Cfalse"
 pageNumber="1"
 pageSize="10"
 isHighlightingEnabled="true"
 highlightStartDelimiter="&lt;h&gt;"
 highlightEndDelimiter="&lt;/h&gt;"
 isDidYouMeanEnabled="true"
 isDebugEnabled="false"
 isHoldingsOnlyEnabled="true">
  <textQueries>
    <textQuery
     textQuery="forests"
     removeCommand="removeTextQuery(forests)"/>
  </textQueries>
  <textFilters>
    <textFilter
     textFilter="Title:rain"
     removeCommand="removeTextFilter(Title:rain)"/>
  </textFilters>
  <rangeFilters>
    <rangeFilter
     fieldName="PublicationDate"
     removeCommand="removeRangeFilter(PublicationDate,1990:2000)">
      <range
       minValue="1990"
       maxValue="2000"/>
    </rangeFilter>
  </rangeFilters>
  <facetValueFilters>
    <facetValueFilter
     fieldName="ContentType"
     value="Journal Article"
     isNegated="false"
     removeCommand="removeFacetValueFilter(ContentType,Journal Article)"
     negateCommand="negateFacetValueFilter(ContentType,Journal Article)"/>
  </facetValueFilters>
  <facetValueGroupFilters>
    <facetValueGroupFilter
     tag="1"
     fieldName="ContentType"
     combineMode="or"
     removeCommand="removeFacetValueGroupFilter(1)">
      <facetValue
       value="Book"
       removeCommand="removeFacetValueGroupFilter(1,Book)"/>
      <facetValue
       value="Journal Article"
       removeCommand="removeFacetValueGroupFilter(1,Journal Article)"/>
    </facetValueGroupFilter>
  </facetValueGroupFilters>
  <facetFields>
    <facetField
     fieldName="ContentType"
     combineMode="or"
     pageNumber="1"
     pageSize="1"
     removeCommand="removeFacetField(ContentType)"/>
  </facetFields>
  <rangeFacetFields>
    <rangeFacetField
     fieldName="PublicationDate"
     removeCommand="removeFacetField(PublicationDate)">
      <range
       minValue="1990"
       maxValue="2000"/>
    </rangeFacetField>
  </rangeFacetFields>
  <sort>
    <sortField
     fieldName="PublicationDate"
     sortOrder="desc"/>
  </sort>
</query>

Example - A query object in JSON format

"query":{
  "queryString":"s.fvgf%3A1=ContentType%2Cor%2CBook%2CJournal+Article&s.hs=%3Ch%3E&s.ho=true&s.fq=Title%3Arain&s.sort=PublicationDate%3Adesc&s.rff=PublicationDate%2C1990%3A2000&s.ps=10&s.debug=false&s.dym=true&s.pn=1&s.rf=PublicationDate%2C1990%3A2000&s.ff=ContentType%2Cor%2C1%2C1&s.hl=true&s.q=forests&s.he=%3C%2Fh%3E&s.fvf=ContentType%2CJournal+Article%2Cfalse",
  "pageNumber":1,
  "pageSize":10,
  "isHighlightingEnabled":true,
  "highlightStartDelimiter":"<h>",
  "highlightEndDelimiter":"</h>",
  "isDidYouMeanEnabled":true,
  "isDebugEnabled":false,
  "isHoldingsOnlyEnabled":true,
  "textQueries":[
    {
      "textQuery":"forests",
      "removeCommand":"removeTextQuery(forests)"
    }
  ],
  "textFilters":[
    {
      "textFilter":"Title:rain",
      "removeCommand":"removeTextFilter(Title:rain)"
    }
  ],
  "rangeFilters":[
    {
      "fieldName":"PublicationDate",
      "range":{
        "minValue":"1990",
        "maxValue":"2000"
      },
      "removeCommand":"removeRangeFilter(PublicationDate,1990:2000)"
    }
  ],
  "facetValueFilters":[
    {
      "fieldName":"ContentType",
      "value":"Journal Article",
      "isNegated":false,
      "removeCommand":"removeFacetValueFilter(ContentType,Journal Article)",
      "negateCommand":"negateFacetValueFilter(ContentType,Journal Article)"
    }
  ],
  "facetValueGroupFilters":[
    {
      "tag":"1",
      "fieldName":"ContentType",
      "combineMode":"or",
      "removeCommand":"removeFacetValueGroupFilter(1)",
      "values":[
        {
          "value":"Book",
          "removeCommand":"removeFacetValueGroupFilter(1,Book)"
        },
        {
          "value":"Journal Article",
          "removeCommand":"removeFacetValueGroupFilter(1,Journal Article)"
        }
      ]
    }
  ],
  "facetFields":[
    {
      "fieldName":"ContentType",
      "combineMode":"or",
      "pageNumber":1,
      "pageSize":1,
      "removeCommand":"removeFacetField(ContentType)"
    }
  ],
  "rangeFacetFields":[
    {
      "fieldName":"PublicationDate",
      "removeCommand":"removeFacetField(PublicationDate)",
      "ranges":[
        {
          "minValue":"1990",
          "maxValue":"2000"
        }
      ]
    }
  ],
  "sort":[
    {
      "fieldName":"PublicationDate",
      "sortOrder":"desc"
    }
  ]
}