Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The pagination can be enabled on selected API methods by explicitly specifying the EnablePagination property on the request object and setting it to value true. There are two other optional properties. The first one is PageSize, which defines the size of each page; the value has boundaries from 1 to 5000. A value outside of the boundary will fail the request. The second optional property is PageIndex, which is used to iterate through pages. The valid value is from 1 0 to N. Whether another page is available can be determined by comparing the count of returned items with the page size. Whenever the page size and the number of returned items are the same, there is probably a subsequent page. The empty page will return an empty list of results.

...

Property

Description

EnablePagination

optional

It must be set to true to request pagination. This must be set explicitly for backward compatibility. The default value is false.

PageSize

optional

Defines the size of a page; the value has boundaries from 1 to 5000. Negative, zero, and values higher than 5000 are not allowed. The default value is 2000.

PageIndex

optional

Used to iterate through pages. The valid value is from 1 0 to N. Negative values are not allowed. The default value is 0.

Example of usage by the SDK

...