Documentation

RGWResponsePagination
in package

Tags
OA\Schema

( schema="RGWResponsePagination", title="Response Pagination", @OA\Xml( name="RGW library" ) )

Table of Contents

$page  : mixed
$records  : mixed
$start  : mixed

Properties

$page

public mixed $page
Tags
OA\Property

( property="page", description="Current page based on records requested", type="int", example=1 )

$records

public mixed $records
Tags
OA\Property

( property="records", description="Number of records returned. This is the same as records in Response Count but not all request might have pagination so don't rely on this property to determine the amount of records returned.", type="int", example=20 )

$start

public mixed $start
Tags
OA\Property

( property="start", description="Starting record for pagination", type="int", example=100 )

Search results