Understanding pagination parameters

This section details the elements that were added to support pagination.

Elements in DWLControl

The following elements were added as child elements in DWLControl to support pagination. These elements can be passed in the request to paginate the results.

Table 1. Elements added as child elements in DWLControl
Name	Description	Value
pageStartIndex	Indicates the start index of the batch results	Numeric
pageEndIndex	Indicates the end index of the batch result	Numeric
returnAvailableReturnCount	Indicates total available records	True/false

When the value of returnAvailableResultCount is true in the request, the total number of records will be returned in the response XML. The XML element that holds this value is availableResultsCount.

Pagination example:

This XML sample shows the pagination parameters in a request:

<DWLControl>
  <requesterName>cusadmin</requesterName>
  <requesterLanguage>100</requesterLanguage>
  <pageStartIndex>1</pageStartIndex>
  <pageEndIndex>2</pageEndIndex>
  <returnAvailableResultCount>true</returnAvailableResultCount>
</DWLControl>

This XML sample showing the response to the pagination request:

<DWLControl>
  <requesterLanguage>100</requesterLanguage>
  <requesterLocale>en</requesterLocale>
  <requesterName>cusadmin</requesterName>
  <requestID>10026111</requestID>
  <pageStartIndex>1</pageStartIndex>
  <pageEndIndex>2</pageEndIndex>
  <returnAvailableResultCount>true</returnAvailableResultCount>
  <availableResultsCount>3</availableResultsCount>
</DWLControl>

In pagination getAll transactions, pageStartIndex and pageEndIndex are both required in the request. However for search transactions, because there is a provision for setting the maximum records, if either pageStartIndex or pageEndIndex is supplied, the other value can be calculated.

The following matrix shows the values entered by the user and the expected return values

Matrix displaying the values entered by users and the expected return values