readme.md

AnimalStatuses

This is the documentation for the AnimalStatuses queries against the RescueGroups.org HTTP API v2.

Full Documentation on RescueGroups.org

Define

Performs animalStatuses.define query. This gives information about the API interface to your application. These are also used to build this SDK.

Example Query

$query = new \RescueGroups\Request\Objects\AnimalStatuses\Define();

$result = $api->executeRequest($query);

GetList

Performs animalStatuses.list list query, typically suitable for filling HTML select fields.

Example List Query

$query = new \RescueGroups\Request\Objects\AnimalStatuses\GetList();
$result = $api->executeRequest($query);

Search

Performs animalStatuses.search search query. This query returns an array of \RescueGroups\Objects\AnimalStatus objects.

Example Search Query

$query = new \RescueGroups\Request\Objects\AnimalStatuses\Search();
$query
    ->setResultStart(10)
    ->setResultLimit(20)
    ->setResultSort('objectField')
    ->setResultOrder('asc')
    ->setCalculateFoundRows(true)
    ->addFilter('someObjectField', 'equals', 33)
    ->addField('objectField')
    ->addField('someOtherObjectField');

$result = $api->executeRequest($query);