Skip to content

Pagination Information

donclem edited this page Nov 2, 2012 · 2 revisions

When the _pagination URI parameter is set to 1 or count, the following properties are set to the values returned in the Pagination hash returned from the API:

$api->last_count
$api->page_size
$api->total_pages
$api->current_page

Example

$result = $api->GetListings(
  array(
    '_pagination' => 1,
    '_limit' => 1,
    '_page' => 1,
    '_filter' => "MlsStatus Eq 'A'"
  ));

echo("Last count: " . $api->last_count . "\n");
echo("Page size: " . $api->page_size . "\n");
echo("Total pages: " . $api->total_pages . "\n");
echo("Current page: " . $api->current_page . "\n");

Spark Platform Documentation

Pagination on the Search and Paging Syntax documentation