This set of resources is used to expose the animals.
Data Guidance
- PhysicalLocation is null when the pet is not in the shelter (ie. not in care).
- Contact location is the last location the animal was linked to, so for outgoing animals such as adopted animals this would be the shelter they were last in.
- Intake region is the location the pet was most recently brought into (if an animal came into the shelter multiple times).
- SecondarySpecies is null when either the pet is a purebred, or the secondary breed is unknown.
- If a date is 1/1/1900 it means no date has been entered (this is the database default).
- Spay / Neuter is not a boolean because it can be either Yes, No, or Unknown.
...
| URI Description | Method | Relative URI | Return Type |
|---|---|---|---|
| Get by ID. | Get | /api/v{version}/animals/{id} | Single: animal |
Search
| Get | /api/v{version}/animals?RegionId={id}&BreedId={id}&ClassId={id}&ExcludedSearchGroupID={id}&SearchGroupId={id}&TypeId={id}&UpdatedSince={dateTime} | Paged: animals |
| Get by person ID | Get | /api/v{version}/animals?personId={id} | Paged: animals |
| Get by kennel ID | Get | /api/v{version}/animals?kennelId={id} | Paged: animals |
...