Page Number Parameter

Syntax

The syntax for the page number parameter is:

s.pn=<pageNumber>

A query string may contain only one s.pn parameter. The default value of this parameter, if unspecified, is 1. The maximum value of this parameter is 50 and the maximum number of records is 1000.


Function

The page number parameter works with the page size parameter to control the offset of the records returned in the results.

Example - Using the page number parameter

This query string returns documents 16 to 30 of the total result set:

  s.pn=2&s.ps=15

Error Messages

  {
    "errors": [
        {
            "code": "page.number.too.large",
            "message": "Maximum supported page number is 50 (provided number is 51)."
        }
    ],
    "sessionId": "48eba240-3d05-4e6c-b0f2-3bd30b34b5bd",
    "spotlightPosition": 0,
    "version": "2.0.0"
  }

  {
    "errors": [
        {
            "code": "results.size.too.large",
            "message": "Maximum supported returned results set size is 1000 (provided size is 1050)."
        }
    ],
    "sessionId": "48eba240-3d05-4e6c-b0f2-3bd30b34b5bd",
    "spotlightPosition": 0,
    "version": "2.0.0"
  }

Try It