Documentation

RGWResponseCount
in package

Tags
OA\Schema

( schema="RGWResponseCount", title="Response Count", @OA\Xml( name="RGW library" ) )

Table of Contents

$returned  : mixed
$total_available  : mixed
$total_filtered  : mixed

Properties

$returned

public mixed $returned
Tags
OA\Property

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

$total_available

public mixed $total_available
Tags
OA\Property

( property="total_available", description="Total number of records available", type="int", example=140 )

$total_filtered

public mixed $total_filtered
Tags
OA\Property

( property="total_filtered", description="Total number of records filtered/found, before pagination", type="int", example=75 )

Search results