Contains parameters you can use to page through response data and to specify the sequence in which items are returned.
When returned in a response, this object contains in the TotalRows element the total number of items that are available to returned.
| Name | Type | Description |
|---|---|---|
| PageSize | Integer | Maximum number of items to be returned in the response. If fewer rows are available, the available rows are returned without error. The default is zero, which returns all rows after the StartIndex. |
| SortByColumn | Integer [ ] | Sort order of response objects as determined by element values. With this parameter you can set the set the sequence in which response objects are returned.
Specify the column as the element number in the object as shown in the WSDL, starting with 1 as the first column, and the sort order as the sign of the number. A negative sign specifies a descending sort order and a positive sign (or no sign) specifies an ascending sort order. For example, to sort the first column in descending order, specify -1. |
| StartIndex | Integer | Counting from zero as the first item in the response, the number of the first item you want. The default is zero. |
| TotalRows | Integer | A returned value, showing the number of of items that are available to be returned if not limited by PageSize or StartIndex. This is a returned value only and any input value is ignored. |