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).
- SecondarySpecies is null when either the pet is a purebred, or the secondary breed is 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} | Multiple animals with pagination |
| Get by person ID | Get | /api/v{version}/animals?personId={id} | Multiple animals with pagination |
...