Retrieve data from Service Manager using Pagination

Retrieving a list of data objects may result in a very large XML response document that could cause performance and memory utilization issues either on the client or the server. To avoid these problems, Service Manager supports the use of pagination, the process of returning pages of data instead of one large response.

To enable pagination, a Web service request can make use of these additional attributes:

  • count – number of records/keys to return. By default all records are returned. This attribute indicates you want to use pagination. (Optional attribute)
  • start – the starting record/key number. By default a retrieve request will start at record 0. (Optional attribute)
  • handle – a record-list handle returned on a previous retrieve request that specified a count.

When pagination is used, the Web service does the following:

  • If there is not a 'start' or 'count' attribute, the service returns all records or keys.
  • With a valid 'start' value and 'no count' attribute, the service returns all records starting from the 'start' attribute.
  • With a valid 'start' attribute and valid 'count' attribute, the service returns the number of keys or records starting from the 'start' attribute.
  • With a negative 'start' attribute, the service returns records from the first record and creates a warning in log file.
  • With a negative 'count' attribute, the service returns one record and creates a warning message in the log file.
  • With the 'start' attribute greater than the total number of records or keys, the service returns no records and creates a message in the error log file.