Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 3.58 KB

readme.md

File metadata and controls

97 lines (66 loc) · 3.58 KB

OutcomesEuthanasias

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

Full Documentation on RescueGroups.org

Define

Performs outcomesEuthanasias.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\OutcomesEuthanasias\Define();

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

GetList

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

Example List Query

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

View

Performs outcomesEuthanasias.view query.

Example Query

$query = new \RescueGroups\Request\Objects\OutcomesEuthanasias\View();

$query->setId("ID");

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

Search

Performs outcomesEuthanasias.search search query. This query returns an array of \RescueGroups\Objects\Search\OutcomesEuthanasia objects.

Example Search Query

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

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

Add

Performs outcomesEuthanasias.add add query to create an instance of an object. Uses classes of type \RescueGroups\Objects\OutcomesEuthanasia as input to create a record. The ID field is ignored. You may specify multiple objects to create multiple records in one request.

Example Add Query

$query = new \RescueGroups\Request\Objects\OutcomesEuthanasias\Add();

$addObject = new \RescueGroups\Objects\OutcomesEuthanasia();
$addObject->animalConditionId = "Condition"
$addObject->date = "Date"
$addObject->notes = "Notes"
$addObject->reasonId = "Euthanasia Reason"

$query->addOutcomesEuthanasia($addObject);

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

Edit

Performs outcomesEuthanasias.edit edit query to edit an object. Uses classes of type \RescueGroups\Objects\OutcomesEuthanasia as input to perform an edit on a record. The ID field is required to be set for this to work. You may specify multiple objects to perform multiple edits in one request.

Example Edit Query

$query = new \RescueGroups\Request\Objects\OutcomesEuthanasias\Edit();

$editObject = new \RescueGroups\Objects\OutcomesEuthanasia();
$editObject->id = "ID"
$editObject->animalConditionId = "Condition"
$editObject->date = "Date"
$editObject->notes = "Notes"
$editObject->reasonId = "Euthanasia Reason"

$query->updateOutcomesEuthanasia($editObject);

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

Change

Performs outcomesEuthanasias.change query.

Example Query

$query = new \RescueGroups\Request\Objects\OutcomesEuthanasias\Change();

$query->setOutcomeId("Outcome");
$query->setAnimalConditionId("Condition");
$query->setDate("Date");
$query->setNotes("Notes");
$query->setReasonId("Euthanasia Reason");

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