The getPendingApprovals, getApprovalRequests and getApprovalHistory operations each return an array of approval requests (that is, their result set) in an ApprovalRequestList message. In certain cases, the result set can be quite large (for example., if you were to retrieve the entire Approval History log). Instead of receiving the entire result set in a single message, you can use the scroll parameter to retrieve the results in blocks of a specified size (e.g., 15 entries at a time). You might use this feature, for example, to display approval requests a page at a time in your client application.

To receive a specified block of results, set the following elements in the scroll parameter when you invoke the getPendingApprovals, getApprovalRequests or getApprovalHistory operation.

For example, let's say you are using the getApprovalHistory operation, and you want to retrieve the contents of the log 20 entries at a time. To do this you would:

You would continue until you reach the end of the result set.

To determine when you have reached the end of the result set, you can check the value in the count parameter in the ApprovalRequestList. This parameter reports the total number of entries in the entire result set.