Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

Note 1 - Paging Parameters

Every function that retrieves a "list" of entities has three optional request[IN] parameters and one result[OUT] parameter that allow implementing paging of the returned "records" (or "rows"). This may be useful when the number of the "records" that will be returned is quite high ( > 5000 ) and this high number may slow down the application.

Paging is implemented in the following way:

1) The "paging" parameter - do not set or set to false to disable paging; the "start" and "limit" parameters will be ignored and no "total" parameter will be returned.

  • set to true to enable paging.

2) The "start" parameter

  • if paging is enabled this parameter sets the record number, inside the current recordset, from which starting returning records.

3) The "limit" parameter

  • if paging is enabled this parameter sets the number of records to return.

    (e.g. If start is set to 100 and limit is set to 200 the function will return records 101 to 300)

4) The "total" parameter

  • if paging is enabled this parameter returns the total number of records in the recordset.
  • this value can be used to properly set up a paging control.

TOCIndex