Property
|
Description
|
#fieldListParameter
|
Specifies the name of the URI parameter that contains the comma separated list of fields to be issued in a request. For example, if you were to issue the following query with #fieldListParameter=fields:
SELECT * FROM ORDERS
The following request would be issued for an entry containing id and success fields:
https://www.example.com/ORDERS?fields=id%2Csuccess
|
#hasMoreElement
|
Specifies the element in the response that denotes there is another page. The service indicates there are no additional pages by omitting the element from the response or returning a value of false. For elements not stored at the top level, this value should include a slash-separated path.
|
#maximumPageSize
|
Specifies the maximum page size in rows.
|
#pageSizeElement
|
Specifies the name of the element containing the page size in rows that must be passed in the URI to get the next page. For elements not stored at the top level, this value should include a slash-separated path.
|
#totalPagesElement
|
Specifies the name of the element in the response that contains the total number of pages contained in the result set. For elements not stored at the top level, this value should include a slash-separated path.
|
#totalRowsElement
|
Specifies the name of the element in the response that contains the total number of pages contained in the result set. For elements not stored at the top level, this value should include a slash-separated path.
|
Property
|
Description
|
#firstRowNumber
|
Specifies the number of the first row. The default is 0; however, some systems begin numbering rows at 1.
|
#pageSizeParameter
|
Specifies the name of the URI parameter that contains the page size.
|
#rowOffsetParameter
|
Specifies the name of the URI parameter that contains the starting row number for this set of rows.
|
Property
|
Description
|
#firstPageNumber
|
Specifies the number of the first page. The default is 0; however, some systems begin numbering pages at 1.
|
#pageSizeParameter
|
Specifies the name of the URI parameter that contains the page size.
|
#pageNumberParameter
|
When requesting a page of rows, this is the name of the URI parameter to contain the page number.
|
Property
|
Description
|
#nextPageElement
|
Specifies the name of the element containing the token that must be passed in the URI to get the next page. For elements not stored at the top level, this value should include a slash-separated path.
|
#nextPageParameter
|
Specifies the name of the URI parameter that holds the token used to fetch the next page. This is the token found on the current page at the location specified by the #NextPageElement.
|
#pageSizeParameter
|
Specifies the name of the URI parameter that contains the page size.
|